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!
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
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.shopId ● Int! non-null scalar
Shop identifier that owns this cart.
References the specific shop configuration including branding, pricing rules, payment methods, and shipping options that apply to this cart.
Cart.userId ● Int deprecated scalar
This field will be removed in a future release, use contact+companyId or customerId instead
Legacy user identifier (deprecated).
Previously used for user association. Use contactId with companyId for B2B customers or customerId for B2C customers instead.
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.
Cart.vouchers ● [CartVoucher!] list object
Applied voucher codes and their details.
Collection of voucher codes that have been successfully applied to this cart, including their discount values and validity information.
Cart.paymentData ● CartPaymentData object
Payment data for this cart.
Cart.postageData ● CartPostageData object
Postage data for this cart.
Cart.total ● CartTotal object
Totals for this cart.
Cart.items ● [CartMainItem!] list object
Cart's main items
Cart.bonusItems ● [CartBaseItem!] list object
Bonus items that are added to this cart through incentives.
Cart.unOrderableItems ● [CartUnOrderableItem!] list object
Items that are added to the Cart, but can't be ordered.
Cart.invoiceAddress ● CartAddress! non-null object
Address the invoice for the order should be sent to.
Cart.deliveryAddress ● CartAddress! non-null object
Address the order should be sent to.
Cart.taxLevels ● [CartTaxLevel!] list object
Amount of tax that applies to this cart per tax code
Cart.payMethods ● [CartPaymethod!] list object
List of selectable paymethods for this cart and applied user.
Cart.carriers ● [CartCarrier!] list object
List of selectable carriers for this cart.
Cart.createdAt ● DateTime scalar
Date this cart has been created.
Cart.lastModifiedAt ● DateTime scalar
Date this cart has been last updated.
Cart.createdBy ● Int scalar
User which created the cart.
Cart.lastModifiedBy ● Int scalar
User which last updated the cart.
Cart.appliedIncentives ● [CartIncentive!] list object
All incentives that apply to this cart.
Cart.valuePoints ● Int scalar
Total amount of value-points that apply to this cart
Cart.shippingMethods ● [CartShippingMethod!] list object
All shipping methods available for this cart.
Cart.language ● String scalar
Language of the order that will be created from this cart. Order confirmation email will be sent in that language.
Cart.purchaseAuthorizationRequired ● Boolean! non-null scalar
Indicates whether authorization is required to finalize the cart
Cart.status ● CartStatus enum
Indicates cart status
Cart.user ● IBaseUser deprecated interface
Deprecated in favor of specific contact or customer fields for better type safety
User associated with this cart.
Returns the user, contact, or customer who owns this cart. Provides unified access to user information regardless of user type.
Cart.contact ● Contact object
Contact person who owns this cart.
Returns the specific contact who created and manages this cart. Used for contact-based order processing and communication.
Cart.customer ● Customer object
Customer who owns this cart.
Returns the customer who created and manages this cart. Used for customer-based order processing and account management.
Cart.company ● Company object
Company context for this cart.
Returns the company associated with this cart, providing organizational context for pricing, catalogs, and order processing rules.
Interfaces
ICart interface
Base interface for shopping cart implementations.
Defines common properties and behaviors shared across different cart types. Provides a unified structure for cart-related operations while allowing for type-specific implementations.
Returned By
cart query ● cartAcceptPurchaseAuthorizationRequest mutation ● cartAddActionCode mutation ● cartAddBundle mutation ● cartAddItem mutation ● cartDeleteItem mutation ● cartRemoveActionCode mutation ● cartRequestPurchaseAuthorization mutation ● cartSetContact mutation ● cartSetCustomer mutation ● cartSetUser mutation ● cartStart mutation ● cartUpdate mutation ● cartUpdateAddress mutation ● cartUpdateItem mutation
Member Of
CartProcessResponse object ● CartResponse object