Home > @poq/sdk-sfcc > Order
Document representing an order.
Signature:
export declare class Order extends BaseModel<Order>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Order class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| adjustedMerchandizeTotalTax? | number | (Optional) The products tax after discounts applying in purchase currency. Adjusted merchandize prices represent the sum of product prices before services such as shipping have been added, but after adjustment from promotions have been added. | |
| adjustedShippingTotalTax? | number | (Optional) The tax of all shipping line items of the line item container after shipping adjustments have been applied. | |
| billingAddress? | OrderAddress | (Optional) | |
| bonusDiscountLineItems? | Array<BonusDiscountLineItem> | (Optional) The bonus discount line items of the line item container. | |
| channelType? | OrderChannelTypeEnum | (Optional) The sales channel for the order. | |
| confirmationStatus? | OrderConfirmationStatusEnum | (Optional) The confirmation status of the order. | |
| couponItems? | Array<CouponItem> | (Optional) The sorted array of coupon items. This array can be empty. | |
| createdBy? | string | (Optional) The name of the user who created the order. | |
| creationDate? | string | (Optional) Returns the value of attribute ‘creationDate’. | |
| currency? | string | (Optional) The ISO 4217 mnemonic code of the currency. | |
| customerInfo? | CustomerInfo | (Optional) | |
| customerName? | string | (Optional) The name of the customer associated with this order. | |
| exportStatus? | OrderExportStatusEnum | (Optional) The export status of the order. | |
| externalOrderStatus? | string | (Optional) The external status of the order. | |
| giftCertificateItems? | Array<GiftCertificateItem> | (Optional) The sorted array of gift certificate line items. This array can be empty. | |
| globalPartyId? | string | (Optional) globalPartyId is managed by Customer 360. Its value can be changed. | |
| lastModified? | string | (Optional) Returns the value of attribute ‘lastModified’. | |
| merchandizeTotalTax? | number | (Optional) The products total tax in purchase currency. Merchandize total prices represent the sum of product prices before services such as shipping or adjustment from promotions have been added. | |
| notes? | SimpleLink | (Optional) | |
| orderNo? | string | (Optional) The order number of the order. | |
| orderPriceAdjustments? | Array<PriceAdjustment> | (Optional) The array of order level price adjustments. This array can be empty. | |
| orderToken? | string | (Optional) The order token used to secure the lookup of an order on base of the plain order number. The order token contains only URL safe characters. | |
| orderTotal? | number | (Optional) The total price of the order, including products, shipping and tax. This property is part of basket checkout information only. | |
| paymentInstruments? | Array<OrderPaymentInstrument> | (Optional) The payment instruments list for the order. | |
| paymentStatus? | OrderPaymentStatusEnum | (Optional) The payment status of the order. | |
| productItems? | Array<ProductItem> | (Optional) The sorted array of product items (up to a maximum of 50 items). This array can be empty. | |
| productSubTotal? | number | (Optional) The total price of all product items after all product discounts. Depending on taxation policy the returned price is net or gross. | |
| productTotal? | number | (Optional) The total price of all product items after all product and order discounts. Depending on taxation policy the returned price is net or gross. | |
| shipments? | Array<Shipment> | (Optional) The array of shipments. This property is part of basket checkout information only. | |
| shippingItems? | Array<ShippingItem> | (Optional) The sorted array of shipping items. This array can be empty. | |
| shippingStatus? | OrderShippingStatusEnum | (Optional) The shipping status of the order. | |
| shippingTotal? | number | (Optional) The total shipping price of the order after all shipping discounts. Excludes tax if taxation policy is net. Includes tax if taxation policy is gross. This property is part of basket checkout information only. | |
| shippingTotalTax? | number | (Optional) The tax of all shipping line items of the line item container before shipping adjustments have been applied. | |
| siteId? | string | (Optional) The site where the order resides. | |
| sourceCode? | string | (Optional) Gets the source code assigned to this basket. | |
| status? | OrderStatusEnum | (Optional) The status of the order. | |
| taxation? | OrderTaxationEnum | (Optional) The taxation the line item container is based on. | |
| taxTotal? | number | (Optional) The total tax amount of the order. This property is part of basket checkout information only. |