Alokai

Order

Representation of an Order Order

export interface Order {
	'appliedOrderPromotions'?: Array<PromotionResult>;
	'appliedProductPromotions'?: Array<PromotionResult>;
	'appliedVouchers'?: Array<Voucher>;
	'calculated'?: boolean;
	'cancellable'?: boolean;
	'chinesePaymentInfo'?: ChinesePaymentInfo;
	'code'?: string;
	'consignments'?: Array<Consignment>;
	'costCenter'?: B2BCostCenter;
	'created'?: string;
	'deliveryAddress'?: Address;
	'deliveryCost'?: Price;
	'deliveryItemsQuantity'?: number;
	'deliveryMode'?: DeliveryMode;
	'deliveryOrderGroups'?: Array<DeliveryOrderEntryGroup>;
	'deliveryStatus'?: string;
	'deliveryStatusDisplay'?: string;
	'deliveryTimeSlot'?: DeliveryTimeSlot;
	'entries'?: Array<OrderEntry>;
	'entryGroups'?: Array<EntryGroup>;
	'guestCustomer'?: boolean;
	'guid'?: string;
	'net'?: boolean;
	'orderDiscounts'?: Price;
	'orgCustomer'?: User;
	'orgUnit'?: B2BUnit;
	'paymentAddress'?: Address;
	'paymentInfo'?: PaymentDetails;
	'paymentStatus'?: string;
	'permissionResults'?: Array<OrderApprovalPermissionResult>;
	'pickupItemsQuantity'?: number;
	'pickupOrderGroups'?: Array<PickupOrderEntryGroup>;
	'productDiscounts'?: Price;
	'purchaseOrderNumber'?: string;
	'requestedRetrievalAt'?: string;
	'returnable'?: boolean;
	'site'?: string;
	'status'?: string;
	'statusDisplay'?: string;
	'store'?: string;
	'subTotal'?: Price;
	'taxInvoice'?: TaxInvoice;
	'totalDiscounts'?: Price;
	'totalItems'?: number;
	'totalPrice'?: Price;
	'totalPriceWithTax'?: Price;
	'totalTax'?: Price;
	'totalUnitCount'?: number;
	'unconsignedEntries'?: Array<OrderEntry>;
	'user'?: Principal;
}

Properties

NameRequiredTypeDescription
appliedOrderPromotionsOptionalArray<PromotionResult>List of applied order promotions {Array<PromotionResult>} Order
appliedProductPromotionsOptionalArray<PromotionResult>List of applied product promotions {Array<PromotionResult>} Order
appliedVouchersOptionalArray<Voucher>List of applied vouchers {Array<Voucher>} Order
calculatedOptionalbooleanFlag showing if order is calculated {boolean} Order
cancellableOptionalbooleanBoolean flag showing if order is cancellable {boolean} Order
chinesePaymentInfoOptionalChinesePaymentInfo{ChinesePaymentInfo} Order
codeOptionalstringCode number of order {string} Order
consignmentsOptionalArray<Consignment>List of consignment {Array<Consignment>} Order
costCenterOptionalB2BCostCenter{B2BCostCenter} Order
createdOptionalstringDate of order creation {string} Order
deliveryAddressOptionalAddress{Address} Order
deliveryCostOptionalPrice{Price} Order
deliveryItemsQuantityOptionalnumberQuantity of delivery items {number} Order
deliveryModeOptionalDeliveryMode{DeliveryMode} Order
deliveryOrderGroupsOptionalArray<DeliveryOrderEntryGroup>List of delivery order entries group {Array<DeliveryOrderEntryGroup>} Order
deliveryStatusOptionalstringOrder delivery status {string} Order
deliveryStatusDisplayOptionalstringOrder delivery status display {string} Order
deliveryTimeSlotOptionalDeliveryTimeSlot{DeliveryTimeSlot} Order
entriesOptionalArray<OrderEntry>List of order entries {Array<OrderEntry>} Order
entryGroupsOptionalArray<EntryGroup>List of entry groups {Array<EntryGroup>} Order
guestCustomerOptionalbooleanFlag showing if customer is Guest customer {boolean} Order
guidOptionalstringGuest user id identifier {string} Order
netOptionalbooleanFlag stating iv value is net-value {boolean} Order
orderDiscountsOptionalPrice{Price} Order
orgCustomerOptionalUser{User} Order
orgUnitOptionalB2BUnit{B2BUnit} Order
paymentAddressOptionalAddress{Address} Order
paymentInfoOptionalPaymentDetails{PaymentDetails} Order
paymentStatusOptionalstringPayment status {string} Order
permissionResultsOptionalArray<OrderApprovalPermissionResult>Results of permissions associated with the order {Array<OrderApprovalPermissionResult>} Order
pickupItemsQuantityOptionalnumberQuantity of pickup items {number} Order
pickupOrderGroupsOptionalArray<PickupOrderEntryGroup>List of pickup order entry group {Array<PickupOrderEntryGroup>} Order
productDiscountsOptionalPrice{Price} Order
purchaseOrderNumberOptionalstringPurchase order number {string} Order
requestedRetrievalAtOptionalstringCustomer requested date for order retrieval {string} Order
returnableOptionalbooleanBoolean flag showing if order is returnable {boolean} Order
siteOptionalstringSite {string} Order
statusOptionalstringStatus of order {string} Order
statusDisplayOptionalstringStatus display {string} Order
storeOptionalstringStore {string} Order
subTotalOptionalPrice{Price} Order
taxInvoiceOptionalTaxInvoice{TaxInvoice} Order
totalDiscountsOptionalPrice{Price} Order
totalItemsOptionalnumber{number} Order
totalPriceOptionalPrice{Price} Order
totalPriceWithTaxOptionalPrice{Price} Order
totalTaxOptionalPrice{Price} Order
totalUnitCountOptionalnumber{number} Order
unconsignedEntriesOptionalArray<OrderEntry>List of unconsigned order entries {Array<OrderEntry>} Order
userOptionalPrincipal{Principal} Order

Referenced Types

On this page