Choose a version:

cart

query

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

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CartCart

•Cart

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 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.