Skip to main content

Cart

Shopping cart entity for managing product selections and orders.

Represents a collection of products or services that users have selected for potential purchase. Carts can be associated with different user types and companies for organizational context.

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

Cart's primary identifier

Cart.channelId ● Int scalar

Channel identifier this cart belongs to.

Cart.shopId ● Int! non-null scalar

Shop identifier this cart belongs to.

Cart.userId ● Int deprecated scalar

DEPRECATED

This field will be removed in a future release, use contact+companyId or customerId instead

Cart.contactId ● Int scalar

ContactId for this cart. Goes in combination with companyId

Cart.customerId ● Int scalar

CustomerId for this cart.

Cart.companyId ● Int scalar

CompanyId the contact belongs to. Goes in combination with contactId

Cart.notes ● String scalar

User's remarks for this cart.

Cart.reference ● String scalar

User's reference for this cart.

Cart.extra3 ● String scalar

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

Cart.extra4 ● String scalar

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

Cart.orderStatus ● String scalar

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

Cart.actionCode ● String scalar

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

Cart.vouchers ● [CartVoucher!] list object

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

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

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