Cart - storefront - OBJECT

Version: 2025-01

Description:

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](https://shopify.dev/custom-storefronts/internationalization/international-pricing) during a customer's session.

Access Scopes

Fields

• appliedGiftCards: AppliedGiftCard! - The gift cards that have been applied to the cart.
• attribute: Attribute - An attribute associated with the cart.
• attributes: Attribute! - The attributes associated with the cart. Attributes are represented as key-value pairs.
• buyerIdentity: CartBuyerIdentity! - Information about the buyer that's interacting with the cart.
• checkoutUrl: URL! - The URL of the checkout for the cart.
• cost: CartCost! - 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](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
• createdAt: DateTime! - The date and time when the cart was created.
• delivery: CartDelivery! - The delivery properties of the cart.
• discountAllocations: CartDiscountAllocation! - The discounts that have been applied to the entire cart.
• discountCodes: CartDiscountCode! - The case-insensitive discount codes that the customer added at checkout.
• estimatedCost: CartEstimatedCost! - The estimated costs that the buyer will pay at checkout. The estimated costs are subject to change and changes will be reflected at checkout. The `estimatedCost` field uses the `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).
• id: ID! - A globally-unique ID.
• metafield: Metafield - A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
• metafields: Metafield! - A list of [custom fields](/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
• note: String - A note that's associated with the cart. For example, the note can be a personalized message to the buyer.
• totalQuantity: Int! - The total number of items in the cart.
• updatedAt: DateTime! - The date and time when the cart was updated.

Connections

• deliveryGroups: CartDeliveryGroupConnection!
• lines: BaseCartLineConnection!

Related queries

• cart Retrieve a cart by its ID. For more information, refer to [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage).

Related mutations

• cartAttributesUpdate Updates the attributes on a cart.
• cartBuyerIdentityUpdate Updates customer information associated with a cart. Buyer identity is used to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) and should match the customer's shipping address.
• cartCreate Creates a new cart.
• cartDeliveryAddressesAdd Adds delivery addresses to the cart.
• cartDeliveryAddressesRemove Removes delivery addresses from the cart.
• cartDeliveryAddressesUpdate Updates one or more delivery addresses on a cart.
• cartDiscountCodesUpdate Updates the discount codes applied to the cart.
• cartGiftCardCodesRemove Removes the gift card codes applied to the cart.
• cartGiftCardCodesUpdate Updates the gift card codes applied to the cart.
• cartLinesAdd Adds a merchandise line to the cart.
• cartLinesRemove Removes one or more merchandise lines from the cart.
• cartLinesUpdate Updates one or more merchandise lines on a cart.
• cartNoteUpdate Updates the note on the cart.
• cartSelectedDeliveryOptionsUpdate Update the selected delivery options for a delivery group.

Related Unions

• MetafieldParentResource A resource that the metafield belongs to.

Examples