Skip to main content

Interface: Cart

Defined in: type/Cart.ts:21

Object class for Cart

Properties​

actionCode?​

optional actionCode?: string

Defined in: type/Cart.ts:43

Action code that is applied to this cart. Is only filled when a valid action code is applied

appliedIncentives?​

optional appliedIncentives?: CartIncentive[]

Defined in: type/Cart.ts:77

All incentives that apply to this cart.

bonusItems?​

optional bonusItems?: CartBaseItem[]

Defined in: type/Cart.ts:55

Bonus items that are added to this cart through incentives.

carriers?​

optional carriers?: CartCarrier[]

Defined in: type/Cart.ts:67

List of selectable carriers for this cart.

cartId​

cartId: string

Defined in: type/Cart.ts:23

Cart's primary identifier

channelId?​

optional channelId?: number

Defined in: type/Cart.ts:25

Channel identifier this cart belongs to.

company?​

optional company?: Company

Defined in: type/Cart.ts:93

Tender Company

companyId?​

optional companyId?: number

Defined in: type/Cart.ts:31

CompanyId the contact belongs to. Goes in combination with contactId

contact?​

optional contact?: Contact

Defined in: type/Cart.ts:89

Tender Contact

contactId?​

optional contactId?: number

Defined in: type/Cart.ts:27

ContactId for this cart. Goes in combination with companyId

createdAt?​

optional createdAt?: string

Defined in: type/Cart.ts:69

Date this cart has been created.

createdBy?​

optional createdBy?: number

Defined in: type/Cart.ts:73

User which created the cart.

customer?​

optional customer?: Customer

Defined in: type/Cart.ts:91

Tender Customer

customerId?​

optional customerId?: number

Defined in: type/Cart.ts:29

CustomerId for this cart.

deliveryAddress​

deliveryAddress: CartAddress

Defined in: type/Cart.ts:61

Address the order should be sent to.

extra3?​

optional extra3?: string

Defined in: type/Cart.ts:37

Additional information field that can be stored with a cart and order.

extra4?​

optional extra4?: string

Defined in: type/Cart.ts:39

Additional information field that can be stored with a cart and order.

invoiceAddress​

invoiceAddress: CartAddress

Defined in: type/Cart.ts:59

Address the invoice for the order should be sent to.

items?​

optional items?: CartMainItem[]

Defined in: type/Cart.ts:53

Cart's main items

language?​

optional language?: string

Defined in: type/Cart.ts:83

Language of the order that will be created from this cart. Order confirmation email will be sent in that language.

lastModifiedAt?​

optional lastModifiedAt?: string

Defined in: type/Cart.ts:71

Date this cart has been last updated.

lastModifiedBy?​

optional lastModifiedBy?: number

Defined in: type/Cart.ts:75

User which last updated the cart.

notes?​

optional notes?: string

Defined in: type/Cart.ts:33

User's remarks for this cart.

orderStatus?​

optional orderStatus?: string

Defined in: type/Cart.ts:41

Status of the order after processing the cart. When order status is UNFINISHED, the cart is pending payment from PSP.

paymentData?​

optional paymentData?: CartPaymentData

Defined in: type/Cart.ts:47

Payment data for this cart.

payMethods?​

optional payMethods?: CartPaymethod[]

Defined in: type/Cart.ts:65

List of selectable paymethods for this cart and applied user.

postageData?​

optional postageData?: CartPostageData

Defined in: type/Cart.ts:49

Postage data for this cart.

purchaseAuthorizationRequired​

purchaseAuthorizationRequired: boolean

Defined in: type/Cart.ts:85

Indicates whether authorization is required to finalize the cart

reference?​

optional reference?: string

Defined in: type/Cart.ts:35

User's reference for this cart.

shippingMethods?​

optional shippingMethods?: CartShippingMethod[]

Defined in: type/Cart.ts:81

All shipping methods available for this cart.

status?​

optional status?: CartStatus

Defined in: type/Cart.ts:87

Indicates cart status

taxLevels?​

optional taxLevels?: CartTaxLevel[]

Defined in: type/Cart.ts:63

Amount of tax that applies to this cart per tax code

total?​

optional total?: CartTotal

Defined in: type/Cart.ts:51

Totals for this cart.

unOrderableItems?​

optional unOrderableItems?: CartUnOrderableItem[]

Defined in: type/Cart.ts:57

Items that are added to the Cart, but can't be ordered.

valuePoints?​

optional valuePoints?: number

Defined in: type/Cart.ts:79

Total amount of value-points that apply to this cart

vouchers?​

optional vouchers?: CartVoucher[]

Defined in: type/Cart.ts:45

Array of voucher codes that are applied to this cart. Is only filled when a valid action is applied.