Cart

Shopping cart entity for managing customer purchases.

Represents a shopping session containing products, customer information, addresses, payment preferences, and all data needed for order processing. Carts can be associated with different customer types and support various business models.

type Cart implements ICart {
  cartId: String!
  channelId: Int
  shopId: Int! @deprecated
  userId: Int @deprecated
  contactId: Int
  customerId: Int
  companyId: Int
  notes: String
  reference: String
  extra3: String
  extra4: String
  orderStatus: String
  actionCode: String
  vouchers: [CartVoucher!]
  paymentData: CartPaymentData
  postageData: CartPostageData
  total: CartTotal
  items: [CartMainItem!]
  bonusItems: [CartBaseItem!]
  unOrderableItems: [CartUnOrderableItem!]
  invoiceAddress: CartAddress!
  deliveryAddress: CartAddress!
  taxLevels: [CartTaxLevel!]
  payMethods: [CartPaymethod!]
  carriers: [CartCarrier!]
  createdAt: DateTime
  lastModifiedAt: DateTime
  createdBy: Int
  lastModifiedBy: Int
  appliedIncentives: [CartIncentive!]
  valuePoints: Int
  shippingMethods: [CartShippingMethod!]
  language: String
  purchaseAuthorizationRequired: Boolean!
  status: CartStatus
  shared: CartSharedAccess
  attributes: [AttributeBulkCreateType!]
  user: IBaseUser @deprecated
  contact: Contact
  customer: Customer
  company: Company
}

Fields

`Cart.cartId` ● `String!` non-null scalar

Unique identifier for the shopping cart.

This UUID serves as the primary key and is used to reference the cart across all operations and API calls.

`Cart.channelId` ● `Int` scalar

Sales channel identifier where the cart was created.

References the specific channel (webshop, mobile app, marketplace) that initiated this cart session, used for channel-specific pricing and business rules.

`Cart.contactId` ● `Int` scalar

Contact identifier for B2B cart association.

Used in combination with companyId to identify the specific contact within a company who owns this cart. Enables contact-specific pricing and permissions.

`Cart.customerId` ● `Int` scalar

Customer identifier for B2C cart association.

Links the cart to an individual customer account for personalized pricing, order history, and customer-specific features. Used for direct consumer sales.

`Cart.companyId` ● `Int` scalar

Company identifier for B2B cart association.

Used in combination with contactId to establish the company context for this cart. Enables company-specific pricing, terms, and business rules.

`Cart.notes` ● `String` scalar

Customer notes and special instructions for the cart.

Free-form text where customers can add delivery instructions, special requests, or other notes that should be considered during order processing.

`Cart.reference` ● `String` scalar

Customer reference number or identifier.

Allows customers to associate their own reference numbers, project codes, or purchase order numbers with the cart for their internal tracking.

`Cart.extra3` ● `String` scalar

Custom metadata field for cart extensions.

Open field for storing additional cart information that can be used in custom implementations, integrations, or frontend customizations.

`Cart.extra4` ● `String` scalar

Additional custom metadata field for cart extensions.

Second open field for storing supplementary cart information for custom business logic, integrations, or specialized cart features.

`Cart.orderStatus` ● `String` scalar

Order processing status after cart conversion.

Indicates the status of the order created from this cart. 'UNFINISHED' means the cart is awaiting payment completion from the payment service provider.

`Cart.actionCode` ● `String` scalar

Applied promotional action code.

Contains the action code (discount, promotion, or special offer) that has been successfully applied to this cart. Only populated when a valid action code is active.