Choose a version:

Cart

object

A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. Learn how to interact with a cart during a customer's session.

Anchor to FieldsFields

Anchor to appliedGiftCardsappliedGiftCards

•[AppliedGiftCard!]!

non-null

The gift cards that have been applied to the cart.

Anchor to attributeattribute

•Attribute

An attribute associated with the cart.

Anchor to keykey •String! required: The key of the attribute.

Anchor to attributesattributes

•[Attribute!]!

non-null

The attributes associated with the cart. Attributes are represented as key-value pairs.

Anchor to buyerIdentitybuyerIdentity

•CartBuyerIdentity!

non-null

Information about the buyer that's interacting with the cart.

Anchor to checkoutUrlcheckoutUrl

•URL!

non-null

The URL of the checkout for the cart.

Anchor to costcost

•CartCost!

non-null

The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The cost field uses the buyerIdentity field to determine international pricing.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the cart was created.

Anchor to deliverydelivery

•CartDelivery!

non-null

The delivery properties of the cart.

Anchor to deliveryGroupsdeliveryGroups

•CartDeliveryGroupConnection!

non-null

The delivery groups available for the cart, based on the buyer identity default delivery address preference or the default address of the logged-in customer.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.
Anchor to withCarrierRateswithCarrierRates •Boolean Default:false: Whether to include carrier-calculated delivery rates in the response.

By default, only static shipping rates are returned. This argument requires mandatory usage of the @defer directive.

For more information, refer to fetching carrier-calculated rates for the cart using @defer.

Anchor to discountAllocationsdiscountAllocations

•[CartDiscountAllocation!]!

non-null

The discounts that have been applied to the entire cart.

Anchor to discountCodesdiscountCodes

•[CartDiscountCode!]!

non-null

The case-insensitive discount codes that the customer added at checkout.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to lineslines

•BaseCartLineConnection!

non-null

A list of lines containing information about the items the customer intends to purchase.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The identifier for the metafield.

Anchor to metafieldsmetafields

•[Metafield]!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.

Anchor to notenote

•String

A note that's associated with the cart. For example, the note can be a personalized message to the buyer.

Anchor to totalQuantitytotalQuantity

•Int!

non-null

The total number of items in the cart.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the cart was updated.

Anchor to estimatedCostestimatedCost

•CartEstimatedCost!

non-nullDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to cart cart

•query

Retrieve a cart by its ID. For more information, refer to Manage a cart with the Storefront API.

Anchor to idid •ID! required: The ID of the cart.

Was this section helpful?

Anchor to MutationsMutations

Anchor to cartAttributesUpdate cartAttributesUpdate

•mutation

Updates the attributes on a cart.

Arguments

Anchor to attributesattributes

•[AttributeInput!]!

required

An array of key-value pairs that contains additional information about the cart.

The input must not contain more than 250 values.

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to cartBuyerIdentityUpdate cartBuyerIdentityUpdate

•mutation

Updates customer information associated with a cart. Buyer identity is used to determine international pricing and should match the customer's shipping address.

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to buyerIdentitybuyerIdentity

•CartBuyerIdentityInput!

required

The customer associated with the cart. Used to determine international pricing. Buyer identity should match the customer's shipping address.

Anchor to cartCreate cartCreate

•mutation

Creates a new cart.

Arguments

Anchor to inputinput

•CartInput

The fields used to create a cart.

Anchor to cartDeliveryAddressesAdd cartDeliveryAddressesAdd

•mutation

Adds delivery addresses to the cart.

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to addressesaddresses

•[CartSelectableAddressInput!]!

required

A list of delivery addresses to add to the cart.

The input must not contain more than 250 values.

Anchor to cartDeliveryAddressesRemove cartDeliveryAddressesRemove

•mutation

Removes delivery addresses from the cart.

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to addressIdsaddressIds •[ID!]! required: A list of delivery addresses by handle to remove from the cart.

The input must not contain more than 250 values.

Anchor to cartDeliveryAddressesReplace cartDeliveryAddressesReplace

•mutation

Replaces delivery addresses on the cart.

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to addressesaddresses

•[CartSelectableAddressInput!]!

required

A list of delivery addresses to replace on the cart.

The input must not contain more than 250 values.

Anchor to cartDeliveryAddressesUpdate cartDeliveryAddressesUpdate

•mutation

Updates one or more delivery addresses on a cart.

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to addressesaddresses

•[CartSelectableAddressUpdateInput!]!

required

The delivery addresses to update.

The input must not contain more than 250 values.

Anchor to cartDiscountCodesUpdate cartDiscountCodesUpdate

•mutation

Updates the discount codes applied to the cart.

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to discountCodesdiscountCodes •[String!]! required: The case-insensitive discount codes that the customer added at checkout.

The input must not contain more than 250 values.

Anchor to cartGiftCardCodesAdd cartGiftCardCodesAdd

•mutation

Adds gift card codes to the cart without replacing existing ones.

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to giftCardCodesgiftCardCodes •[String!]! required: The case-insensitive gift card codes to add.

The input must not contain more than 250 values.

Anchor to cartGiftCardCodesRemove cartGiftCardCodesRemove

•mutation

Removes the gift card codes applied to the cart.

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to appliedGiftCardIdsappliedGiftCardIds •[ID!]! required: The gift cards to remove.

The input must not contain more than 250 values.

Anchor to cartGiftCardCodesUpdate cartGiftCardCodesUpdate

•mutation

Updates the gift card codes applied to the cart.

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to giftCardCodesgiftCardCodes •[String!]! required: The case-insensitive gift card codes.

The input must not contain more than 250 values.

Anchor to cartLinesAdd cartLinesAdd

•mutation

Adds a merchandise line to the cart.

Arguments

Anchor to cartIdcartId

•ID!

required

The ID of the cart.

Anchor to lineslines

•[CartLineInput!]!

required

A list of merchandise lines to add to the cart.

The input must not contain more than 250 values.

Anchor to cartLinesRemove cartLinesRemove

•mutation

Removes one or more merchandise lines from the cart.

Anchor to cartIdcartId •ID! required: The ID of the cart.
Anchor to lineIdslineIds •[ID!]! required: The merchandise line IDs to remove.

The input must not contain more than 250 values.