Skip to navigation
GraphQLStorefrontTypesObjects

Checkout

OBJECT
The checkout.

Fields

idStringRequired
The ID of an object
entityIdStringRequired
Checkout ID.
currencyCodeStringRequired

ISO-4217 currency code of the checkout.

displayCurrencyCodeStringRequired

ISO-4217 currency code. Applied DisplayCurrencyCode for the checkout.

shippingCostBeforeDiscountMoneyRequired
Total shipping cost before any discounts are applied.
shippingCostBeforeDiscountInDisplayCurrencyMoneyRequired
Shipping cost before discount in display currency.
comparisonShippingCostMoneyRequired
The total shipping cost before coupon discounts are applied.
comparisonShippingCostInDisplayCurrencyMoneyRequired
Comparison shipping cost in display currency.
createdAtDateTimeExtendedRequired
Time when the checkout was created.
updatedAtDateTimeExtendedRequired
Time when the checkout was last updated.
couponslist of CheckoutCouponsRequired
Coupons applied at checkout level.
giftCertificateslist of CheckoutGiftCertificatesRequired
Gift Certificates applied at checkout level.
promotionslist of CheckoutPromotionsRequired
List of promotions
feeslist of CheckoutFeesRequired
List of fees applied.
totalDiscountMoneyRequired
Total discount amount applied to the checkout.
totalDiscountInDisplayCurrencyMoneyRequired
Total discount amount in display currency.
displayDiscountTotalMoneyRequired

Display discount total amount excluding product-level auto promotion discounts and shipping auto promotion discounts.

displayDiscountTotalInDisplayCurrencyMoneyRequired
Display discount total amount in display currency.
orderBasedAutoDiscountTotalMoneyRequired

Order-based automatic discount total amount.

orderBasedAutoDiscountTotalInDisplayCurrencyMoneyRequired

Order-based automatic discount total amount in display currency.

manualDiscountTotalMoneyRequired
Manual discount total amount.
manualDiscountTotalInDisplayCurrencyMoneyRequired
Manual discount total amount in display currency.
billingAddressCheckoutBillingAddressOptional
Billing address information.
cartCartOptional
Cart associated with the checkout.
shippingConsignmentslist of CheckoutShippingConsignmentsOptional
List of shipping consignments.
shippingCostTotalMoneyOptional
Total shipping cost before any discounts are applied.
shippingCostTotalInDisplayCurrencyMoneyOptional
Total shipping cost in display currency.
giftWrappingCostTotalMoneyOptional
Gift wrapping cost for all items, including or excluding tax.
giftWrappingCostTotalInDisplayCurrencyMoneyOptional
Gift wrapping cost in display currency.
handlingCostTotalMoneyOptional
Handling cost for all consignments including or excluding tax.
handlingCostTotalInDisplayCurrencyMoneyOptional
Handling cost in display currency.
taxTotalMoneyOptional
Total amount of taxes applied.
taxTotalInDisplayCurrencyMoneyOptional
Total amount of taxes in display currency.
taxeslist of CheckoutTaxesOptional
List of taxes applied.
subtotalMoneyOptional

Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.

subtotalInDisplayCurrencyMoneyOptional
Subtotal in display currency.
grandTotalMoneyOptional
The total payable amount, before applying any store credit or gift certificate.
grandTotalInDisplayCurrencyMoneyOptional
Grand total in display currency.
customerMessageStringOptional
Shopper's message provided as details for the order to be created from the checkout.
outstandingBalanceMoneyOptional

GrandTotal subtract the store-credit amount.

outstandingBalanceInDisplayCurrencyMoneyOptional
Outstanding balance in display currency.
versionIntegerOptional
The current version of the checkout, which is updated with every change.
orderOrderOptional
Order associated with the checkout.