Cart
A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.
Properties
id
stringRequiredThe cart's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
deleted_at
null | DateRequiredThe date with timezone at which the resource was deleted.
object
"cart"RequiredDefault: "cart"
email
stringRequiredThe email associated with the cart
billing_address_id
stringRequiredThe billing address's ID
The details of the billing address associated with the cart.
shipping_address_id
stringRequiredThe shipping address's ID
The details of the shipping address associated with the cart.
The line items added to the cart.
region_id
stringRequiredThe region's ID
The details of the region associated with the cart.
An array of details of all discounts applied to the cart.
An array of details of all gift cards applied to the cart.
customer_id
stringRequiredThe customer's ID
The details of the customer the cart belongs to.
The details of the selected payment session in the cart.
The details of all payment sessions created on the cart.
payment_id
stringRequiredThe payment's ID if available
The details of the payment associated with the cart.
The details of the shipping methods added to the cart.
The cart's type.
Default: default
completed_at
DateRequiredThe date with timezone at which the cart was completed.
payment_authorized_at
DateRequiredThe date with timezone at which the payment was authorized.
idempotency_key
stringRequiredRandomly generated key used to continue the completion of a cart in case of failure.
context
Record<string, unknown>RequiredThe context of the cart which can include info like IP or user agent.
metadata
Record<string, unknown>RequiredAn optional key-value map with additional details
sales_channel_id
null | stringRequiredThe sales channel ID the cart is associated with.
The details of the sales channel associated with the cart.
The associated sales channels.
shipping_total
numberThe total of shipping
discount_total
numberThe total of discount rounded
raw_discount_total
numberThe total of discount
item_tax_total
null | numberThe total of items with taxes
shipping_tax_total
null | numberThe total of shipping with taxes
tax_total
null | numberThe total of tax
refunded_total
numberThe total amount refunded if the order associated with this cart is returned.
total
numberThe total amount of the cart
subtotal
numberThe subtotal of the cart
refundable_amount
numberThe amount that can be refunded
gift_card_total
numberThe total of gift cards
gift_card_tax_total
numberThe total of gift cards with taxes
Was this section helpful?