Skip to content

Latest commit

 

History

History
55 lines (53 loc) · 3.79 KB

File metadata and controls

55 lines (53 loc) · 3.79 KB

Cart

Properties

Name Type Description Notes
id String The cart's ID
email String The email associated with the cart
billingAddressId String The billing address's ID
billingAddress Address [optional]
shippingAddressId String The shipping address's ID
shippingAddress Address [optional]
items List<LineItem> Available if the relation `items` is expanded. [optional]
regionId String The region's ID
region Region [optional]
discounts List<Discount> Available if the relation `discounts` is expanded. [optional]
giftCards List<GiftCard> Available if the relation `gift_cards` is expanded. [optional]
customerId String The customer's ID
customer Object A customer object. Available if the relation `customer` is expanded. [optional]
paymentSession Object The selected payment session in the cart.
paymentSessions List<Object> The payment sessions created on the cart. [optional]
paymentId String The payment's ID if available
payment Object Available if the relation `payment` is expanded. [optional]
shippingMethods List<ShippingMethod> The shipping methods added to the cart. [optional]
type TypeEnum The cart's type.
completedAt OffsetDateTime The date with timezone at which the cart was completed.
paymentAuthorizedAt OffsetDateTime The date with timezone at which the payment was authorized.
idempotencyKey String Randomly generated key used to continue the completion of a cart in case of failure.
context Object The context of the cart which can include info like IP or user agent.
salesChannelId String The sales channel ID the cart is associated with. [optional]
salesChannel SalesChannel [optional]
createdAt OffsetDateTime The date with timezone at which the resource was created.
updatedAt OffsetDateTime The date with timezone at which the resource was updated.
deletedAt OffsetDateTime The date with timezone at which the resource was deleted.
metadata Object An optional key-value map with additional details
shippingTotal Integer The total of shipping [optional]
discountTotal Integer The total of discount [optional]
itemTaxTotal Integer The total of items with taxes [optional]
shippingTaxTotal Integer The total of shipping with taxes [optional]
taxTotal Integer The total of tax [optional]
refundedTotal Integer The total amount refunded if the order associated with this cart is returned. [optional]
total Integer The total amount of the cart [optional]
subtotal Integer The subtotal of the cart [optional]
refundableAmount Integer The amount that can be refunded [optional]
giftCardTotal Integer The total of gift cards [optional]
giftCardTaxTotal Integer The total of gift cards with taxes [optional]

Enum: TypeEnum

Name Value
DEFAULT "default"
SWAP "swap"
DRAFT_ORDER "draft_order"
PAYMENT_LINK "payment_link"
CLAIM "claim"