---
title: "Checkout"
description: "Information about a checkout."
doc_type: graphql
doc_category: storefront
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout'
  md: 'https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout.md'
---
# Checkout

Information about a checkout.

- **API Version:** v20270301
- **API Type:** Storefront
- **API Protocol:** GraphQL
- **Operation Type:** Object

## Fields

* `webUrl`

  [URL!](https://developer.shopline.com/docs/storefront-api/common/scalars/url.md)

  The checkout page URL.
  :::danger{title="Deprecated"}
  This field is deprecated as of `v20251201`. Use `checkoutUrl` instead.
  :::

* `email`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  The associated email address.

* `id`

  [String!](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  The globally unique identifier for the checkout.

* `appliedGiftCards`

  [[AppliedGiftCard]](https://developer.shopline.com/docs/storefront-api/member-system/objects/applied-gift-card.md)

  A list of gift cards applied to the checkout.

* `buyerIdentity`

  [CheckoutBuyerIdentity](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-buyer-identity.md)

  The information about the associated customer identity.

* `completedAt`

  [[Date]](https://developer.shopline.com/docs/storefront-api/common/scalars/date.md)

  The date and time when the checkout was completed. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).     
  Example: `2024-08-31T02:20:26+08:00`

* `createdAt`

  [Date](https://developer.shopline.com/docs/storefront-api/common/scalars/date.md)

  The date and time when the checkout was created. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).   
  Example: `2024-08-31T02:20:26+08:00`

* `currencyCode`

  [CurrencyCode](https://developer.shopline.com/docs/storefront-api/common-objects/enums/currency-code.md)

  The currency code used for the checkout settlement.

* `lineItemsSubtotalPrice`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The subtotal price of all line items, before discounts are deducted and shipping fees, duties, and taxes are included.

* `note`

  [String](https://developer.shopline.com/docs/storefront-api/common/scalars/string.md)

  The checkout note.

* `paymentDue`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The remaining payable amount, after shipping fees, duties, and taxes are included and discounts and gift cards are deducted.

* `customAttributes`

  [[Attribute]](https://developer.shopline.com/docs/storefront-api/common-objects/objects/attribute.md)

  A list of custom attributes attached to the checkout, including additional business information.

* `requiresShipping`

  [Boolean](https://developer.shopline.com/docs/storefront-api/common/scalars/boolean.md)

  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.

* `shippingAddress`

  [ShippingAddress](https://developer.shopline.com/docs/storefront-api/common-objects/objects/shipping-address.md)

  The shipping address for the checkout.

* `shippingDiscountAllocations`

  [[DiscountAllocation]](https://developer.shopline.com/docs/storefront-api/common-objects/objects/discount-allocation.md)

  A list of allocation details for the discounts applied to shipping fees.

* `shippingLine`

  [ShippingRate](https://developer.shopline.com/docs/storefront-api/common-objects/objects/shipping-rate.md)

  The shipping line, including the shipping option and rate selected by the customer.

* `subtotalPrice`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The subtotal price of all items in the checkout, before shipping fees, duties, and taxes are included and after discounts are deducted.

* `taxesIncluded`

  [Boolean](https://developer.shopline.com/docs/storefront-api/common/scalars/boolean.md)

  Whether taxes are included in the line item prices and the shipping line price.
    - `true`: Included
    - `false`: Not included

* `totalPrice`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The total price of all items in the checkout, after shipping fees, duties, and taxes are included and after discounts are deducted.

* `totalTax`

  [Money](https://developer.shopline.com/docs/storefront-api/common-objects/objects/money.md)

  The total amount of taxes applied to the line items and the shipping line.

* `updatedAt`

  [Date](https://developer.shopline.com/docs/storefront-api/common/scalars/date.md)

  The date and time when the checkout was last updated. Format: [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).   
  Example: `2024-08-31T02:20:26+08:00`

* `discountApplications`

  [[DiscountApplication]](https://developer.shopline.com/docs/storefront-api/common-objects/objects/discount-application.md)

  A list of discounts applied to the checkout.

* `lineItems`

  [[CheckoutLineItem]](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-line-item.md)

  A list of line items.

* `availableShippingRates`

  [AvailableShippingRates](https://developer.shopline.com/docs/storefront-api/common-objects/objects/available-shipping-rates.md)

  A set of available shipping rates.

* `checkoutUrl`

  [URI](https://developer.shopline.com/docs/storefront-api/common/scalars/uri.md)

  The checkout page URL.

## Field from

* [CheckoutCreatePayload](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-create-payload.md).checkout

* [CheckoutLineItemsUpdatePayload](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-line-items-update-payload.md).checkout

* [CheckoutLineItemsReplacePayload](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-line-items-replace-payload.md).checkout

* [CheckoutLineItemsAddPayload](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-line-items-add-payload.md).checkout

* [CheckoutDiscountCodeRemovePayload](https://developer.shopline.com/docs/storefront-api/checkouts/objects/checkout-discount-code-remove-payload.md).checkout