Home > @poq/sdk-sfcc > Basket
Document representing a basket.
Signature:
export declare class Basket extends BaseModel<Basket>
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(params) | Constructs a new instance of the Basket 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. | |
| agentBasket? | boolean | (Optional) Is the basket created by an agent? | |
| basketId? | string | (Optional) The unique identifier for the basket. | |
| billingAddress? | OrderAddress | (Optional) | |
| bonusDiscountLineItems? | Array<BonusDiscountLineItem> | (Optional) The bonus discount line items of the line item container. | |
| channelType? | BasketChannelTypeEnum | (Optional) The sales channel for the order. This is a read-only attribute that can’t be modified by an OCAPI call. For OCAPI, the sales channel is determined based on the client ID and token used for the OCAPI call. Usually, a customer-based authentication sets the channel to Storefront, and an agent-based authentication sets it to CallCenter. Using applications that use other client IDs for OCAPI calls, like Customer Service Center, will set different channel types. To modify the channel type in OCAPI, use a hook. * | |
| couponItems? | Array<CouponItem> | (Optional) The sorted array of coupon items. This array can be empty. | |
| creationDate? | string | (Optional) Returns the value of attribute ‘creationDate’. | |
| cSessionAddressBook? | string | (Optional) | |
| currency? | string | (Optional) The ISO 4217 mnemonic code of the currency. | |
| customerInfo? | CustomerInfo | (Optional) | |
| giftCertificateItems? | Array<GiftCertificateItem> | (Optional) The sorted array of gift certificate line items. This array can be empty. | |
| inventoryReservationExpiry? | string | (Optional) | |
| 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) | |
| orderPriceAdjustments? | Array<PriceAdjustment> | (Optional) The array of order level price adjustments. This array can be empty. | |
| 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. | |
| 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. | |
| 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. | |
| sourceCode? | string | (Optional) Gets the source code assigned to this basket. | |
| taxation? | BasketTaxationEnum | (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. |