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