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
| Name | Required | Type | Description |
|---|---|---|---|
appliedOrderPromotions | Optional | Array<PromotionResult> | List of applied order promotions {Array<PromotionResult>} Order |
appliedProductPromotions | Optional | Array<PromotionResult> | List of applied product promotions {Array<PromotionResult>} Order |
appliedVouchers | Optional | Array<Voucher> | List of applied vouchers {Array<Voucher>} Order |
calculated | Optional | boolean | Flag showing if order is calculated {boolean} Order |
cancellable | Optional | boolean | Boolean flag showing if order is cancellable {boolean} Order |
chinesePaymentInfo | Optional | ChinesePaymentInfo | {ChinesePaymentInfo} Order |
code | Optional | string | Code number of order {string} Order |
consignments | Optional | Array<Consignment> | List of consignment {Array<Consignment>} Order |
costCenter | Optional | B2BCostCenter | {B2BCostCenter} Order |
created | Optional | string | Date of order creation {string} Order |
deliveryAddress | Optional | Address | {Address} Order |
deliveryCost | Optional | Price | {Price} Order |
deliveryItemsQuantity | Optional | number | Quantity of delivery items {number} Order |
deliveryMode | Optional | DeliveryMode | {DeliveryMode} Order |
deliveryOrderGroups | Optional | Array<DeliveryOrderEntryGroup> | List of delivery order entries group {Array<DeliveryOrderEntryGroup>} Order |
deliveryStatus | Optional | string | Order delivery status {string} Order |
deliveryStatusDisplay | Optional | string | Order delivery status display {string} Order |
deliveryTimeSlot | Optional | DeliveryTimeSlot | {DeliveryTimeSlot} Order |
entries | Optional | Array<OrderEntry> | List of order entries {Array<OrderEntry>} Order |
entryGroups | Optional | Array<EntryGroup> | List of entry groups {Array<EntryGroup>} Order |
guestCustomer | Optional | boolean | Flag showing if customer is Guest customer {boolean} Order |
guid | Optional | string | Guest user id identifier {string} Order |
net | Optional | boolean | Flag stating iv value is net-value {boolean} Order |
orderDiscounts | Optional | Price | {Price} Order |
orgCustomer | Optional | User | {User} Order |
orgUnit | Optional | B2BUnit | {B2BUnit} Order |
paymentAddress | Optional | Address | {Address} Order |
paymentInfo | Optional | PaymentDetails | {PaymentDetails} Order |
paymentStatus | Optional | string | Payment status {string} Order |
permissionResults | Optional | Array<OrderApprovalPermissionResult> | Results of permissions associated with the order {Array<OrderApprovalPermissionResult>} Order |
pickupItemsQuantity | Optional | number | Quantity of pickup items {number} Order |
pickupOrderGroups | Optional | Array<PickupOrderEntryGroup> | List of pickup order entry group {Array<PickupOrderEntryGroup>} Order |
productDiscounts | Optional | Price | {Price} Order |
purchaseOrderNumber | Optional | string | Purchase order number {string} Order |
requestedRetrievalAt | Optional | string | Customer requested date for order retrieval {string} Order |
returnable | Optional | boolean | Boolean flag showing if order is returnable {boolean} Order |
site | Optional | string | Site {string} Order |
status | Optional | string | Status of order {string} Order |
statusDisplay | Optional | string | Status display {string} Order |
store | Optional | string | Store {string} Order |
subTotal | Optional | Price | {Price} Order |
taxInvoice | Optional | TaxInvoice | {TaxInvoice} Order |
totalDiscounts | Optional | Price | {Price} Order |
totalItems | Optional | number | {number} Order |
totalPrice | Optional | Price | {Price} Order |
totalPriceWithTax | Optional | Price | {Price} Order |
totalTax | Optional | Price | {Price} Order |
totalUnitCount | Optional | number | {number} Order |
unconsignedEntries | Optional | Array<OrderEntry> | List of unconsigned order entries {Array<OrderEntry>} Order |
user | Optional | Principal | {Principal} Order |