Entities

Cart

Cart entity - components, queries, links, and related actions

Your storefront encounters the Cart entity when a visitor adds products to their shopping session. A Cart holds summary information such as the total item count and cost breakdowns. Individual line items are represented as separate CartItem entities linked from the Cart.

Components

Base

CartBase

base

Total item quantity, custom fields, and an optional checkout link.

Schema

totalQuantity

numberrequired

Total number of items in the cart.

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

checkoutLink

Link

A link to an internal or external page. Links can be of different types for different link-targets.

Cost

CartCost

cost

Price breakdown for the entire cart: subtotal, total, shipping, duty, and tax information.

Schema

subtotal

Money { amount, currency }required

subtotalIsEstimated

booleanrequired

Whether the subtotal is estimated.

total

Money { amount, currency }required

totalIsEstimated

booleanrequired

Whether the total is estimated.

shipping

{ total, isEstimated }

duty

{ total, isEstimated, isIncluded }

tax

{ total, isEstimated, isIncluded }

taxes

{ rate, amount, name }[]

Aggregation of taxes applied to the cart-items.

Queries

GetCurrentCartQuery - Retrieve the current cart for the customer session.