Checkout
object
Information about a checkout.
Fields
The checkout page URL.
Deprecated
This field is deprecated as of
v20251201. Use checkoutUrl instead.The associated email address.
The globally unique identifier for the checkout.
A list of gift cards applied to the checkout.
The information about the associated customer identity.
The date and time when the checkout was completed. Format: ISO 8601.
Example:
Example:
2024-08-31T02:20:26+08:00The date and time when the checkout was created. Format: ISO 8601.
Example:
Example:
2024-08-31T02:20:26+08:00The currency code used for the checkout settlement.
The subtotal price of all line items, before discounts are deducted and shipping fees, duties, and taxes are included.
The checkout note.
The remaining payable amount, after shipping fees, duties, and taxes are included and discounts and gift cards are deducted.
A list of custom attributes attached to the checkout, including additional business information.
Whether the checkout contains items that require shipping.
true: The checkout contains items that require shipping.false: The checkout does not contain any item that requires shipping.
The shipping address for the checkout.
A list of allocation details for the discounts applied to shipping fees.
The shipping line, including the shipping option and rate selected by the customer.
The subtotal price of all items in the checkout, before shipping fees, duties, and taxes are included and after discounts are deducted.
Whether taxes are included in the line item prices and the shipping line price.
true: Includedfalse: Not included
The total price of all items in the checkout, after shipping fees, duties, and taxes are included and after discounts are deducted.
The total amount of taxes applied to the line items and the shipping line.
The date and time when the checkout was last updated. Format: ISO 8601.
Example:
Example:
2024-08-31T02:20:26+08:00A list of discounts applied to the checkout.
A list of line items.
A set of available shipping rates.
The checkout page URL.
Was this article helpful to you?
'%3e%3crect%20x='6'%20y='7.13049'%20width='13'%20height='10'%20rx='1'%20fill='black'/%3e%3cpath%20d='M12.4998%2012.936L-3.65042%200.604835L28.65%200.604838L12.4998%2012.936Z'%20stroke='white'%20stroke-linejoin='round'/%3e%3c/g%3e%3cdefs%3e%3cclipPath%20id='clip0_716_14611'%3e%3crect%20x='6'%20y='7.13049'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e)
'%3e%3crect%20x='5.63086'%20y='7.26086'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3cpath%20d='M12.1306%2013.0664L-4.01956%200.735206L28.2809%200.735209L12.1306%2013.0664Z'%20stroke='%231A2C42'%20stroke-linejoin='round'/%3e%3c/g%3e%3cdefs%3e%3cclipPath%20id='clip0_716_14599'%3e%3crect%20x='5.63086'%20y='7.26086'%20width='13'%20height='10'%20rx='1'%20fill='white'/%3e%3c/clipPath%3e%3c/defs%3e%3c/svg%3e)