Cart GraphQL

Served by CartModule on commercetools, CartModule on medusa and CartModule on sfcc.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the cart types page.

Operations

Operation	Description	Served by
`addressValidate`Query	Validate a shipping or billing address for correctness and formatting	commercetoolsmedusasfcc
`cart`Query	Get the current user's shopping cart with all line items and totals	commercetoolsmedusasfcc
`cartBundleAdd`Mutation	Add a main product and the extras chosen with it as a bundle, in one call.	commercetoolsmedusasfcc
`cartChangesAcknowledge`Mutation	The buyer has seen the cart's changes; they are not listed again	commercetoolsmedusasfcc
`cartCreate`Mutation	Create an empty cart.	commercetoolsmedusasfcc
`cartDiscountCodeAdd`Mutation	Apply a discount code to the cart	commercetoolsmedusasfcc
`cartDiscountCodeRemove`Mutation	Remove a discount code from the cart	commercetoolsmedusasfcc
`cartLineItemsAdd`Mutation	Add line items to cart or create a new cart	commercetoolsmedusasfcc
`cartLineItemsRemove`Mutation	Remove line items from the cart	commercetoolsmedusasfcc
`cartLineItemsUpdate`Mutation	Update quantities of existing line items	commercetoolsmedusasfcc
`cartPaymentRemove`Mutation	Remove a payment that has only reserved money from the cart, such as a gift card, and give the reservation back.	commercetoolsmedusasfcc
`cartSetDeliveryRemarks`Mutation	Record a note for whoever delivers the goods.	commercetoolsmedusasfcc
`cartSetPurchaseOrderNumber`Mutation	Record the buyer's own reference for this purchase, usually a purchase order number.	commercetoolsmedusasfcc
`cartSetVatNumber`Mutation	Record the VAT number of the company the buyer orders for, with its country prefix, such as DE123456789.	commercetoolsmedusasfcc
`cartUpdate`Mutation	Update cart with various actions	commercetoolsmedusasfcc

Types

Type	Description
`AddressSuggestion`Object
`AddressValidationResult`Object
`AppliedDiscount`Object	A discount applied to a cart or one of its lines, by the name it is known by.
`Cart`Object	Shopping cart containing line items and checkout information
`CartAddOnInput`Input object	An add-on to add with a line.
`CartChangesAcknowledgeError`Union
`CartChangesAcknowledgeResponse`Object	Response for acknowledging a cart's changes
`CartCreateError`Union	Error union for cart create
`CartCreateResponse`Object	Response for creating a cart
`CartDiscountCode`Object	A CartDiscountCode represents a discount that is applied to the cart
`CartDiscountCodeAddError`Union	Error union for cart discount code add
`CartDiscountCodeAddResponse`Object	Response for adding discount code to cart
`CartDiscountCodeRemoveError`Union	Error union for cart discount code remove
`CartDiscountCodeRemoveResponse`Object	Response for removing discount code from cart
`CartFreeDelivery`Object	How far a cart is from free delivery
`CartLineChange`Object	One change to a line since the buyer last acknowledged the cart
`CartLineChangeType`Enum	What happened to a line since the buyer last acknowledged the cart
`CartLineItem`Interface	Interface for cart line items
`CartLineItemAddFailureType`Enum	Why a requested line was not added.
`CartLineItemAddInput`Input object	Input for creating a new line item
`CartLineItemAddResult`Object	The outcome for one requested line.
`CartLineItemBackorder`Object	The part of a cart line that cannot ship now.
`CartLineItemRoleType`Enum	What a line is to another line in the cart.
`CartLineItemsAddError`Union	Error union for cart line items add
`CartLineItemsAddResponse`Object	Response for adding line items to cart
`CartLineItemsRemoveError`Union	Error union for cart line items remove
`CartLineItemsRemoveResponse`Object	Response for removing line items from cart
`CartLineItemsUpdateError`Union	Error union for cart line items update
`CartLineItemsUpdateResponse`Object	Response for updating line items in cart
`CartLineItemUpdateFailureType`Enum	Why a line's quantity was not changed.
`CartLineItemUpdateInput`Input object	Input for updating an existing line item
`CartLineItemUpdateResult`Object	The outcome for one requested quantity change.
`CartLineQuantityLimitType`Enum	What limits the quantity of a line.
`CartLineQuantityRule`Object	How many of a line can be ordered.
`CartMinimumOrder`Object	How far a business unit's cart is from the unit's minimum order value
`CartPayment`Object	A payment on a cart, as far as a buyer needs to see it.
`CartPaymentRemoveError`Union
`CartPaymentRemoveResponse`Object	Response for removing a payment from the cart
`CartPaymentStatusType`Enum	How far a payment on a cart has got.
`CartSetBillingAddressInput`Input object	Input for setting billing address on cart
`CartSetCustomerEmailInput`Input object	Input for setting customer email on cart
`CartSetDeliveryRemarksError`Union	Error union for recording a delivery note
`CartSetDeliveryRemarksResponse`Object	Response for recording a delivery note on a cart
`CartSetPaymentMethodInput`Input object	Input for setting payment method on cart
`CartSetPurchaseOrderNumberError`Union	Error union for recording a purchase reference
`CartSetPurchaseOrderNumberResponse`Object	Response for recording the buyer's purchase reference on a cart
`CartSetShippingAddressInput`Input object	Input for setting shipping address on cart
`CartSetShippingMethodInput`Input object	Input for setting shipping method on cart
`CartSetVatNumberError`Union	Error union for recording a VAT number
`CartSetVatNumberResponse`Object	Response for recording a VAT number on a cart
`CartSingleLineItem`Object	Individual line item in a cart
`CartUpdateAction`Input object	Union of all cart update actions
`CartUpdateError`Union	Error union for cart update
`CartUpdateResponse`Object	Response for cart update operations
`ShippingMethod`Object	A way the cart can be shipped, at the price it would be charged.
`ShippingMethodInput`Input object	Input for selecting a shipping method