---
title: "checkout"
description: "checkout query"
doc_type: graphql
doc_category: storefront
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/storefront-api/checkouts/queries/checkout'
  md: 'https://developer.shopline.com/docs/storefront-api/checkouts/queries/checkout.md'
---
# checkout

checkout query

- **Required Scopes:** `unauthenticated_read_checkouts_info`
- **API Version:** v20270301
- **API Type:** Storefront
- **API Protocol:** GraphQL
- **Operation Type:** Query

## Type Signature

`Checkout`

## Required Permissions

* `unauthenticated_read_checkouts_info`

An access token is required to call this API. Refer to [Authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/storefront-api/overview.md) for more information about how to obtain the token.

## Arguments

* `id`

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

  Checkout id

## Returns

* `appliedGiftCards`

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

  The gift cards used on the checkout.

* `availableShippingRates`

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

  The available shipping rates for this Checkout.Should only be used when checkout requiresShipping is true and the shipping address is valid.

* `buyerIdentity`

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

  The identity of the customer associated with the checkout.

* `completedAt`

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

  The date and time when the checkout was completed.

* `createdAt`

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

  The date and time when the checkout was created.

* `currencyCode`

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

  The currency code for the checkout.

* `customAttributes`

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

  A list of extra information that is added to the checkout.

* `discountApplications`

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

  Discounts that have been applied on the checkout.

* `email`

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

  The email attached to this checkout.

* `id`

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

  A globally-unique identifier.

* `lineItems`

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

  A list of line item objects, each one containing information about an item in the checkout.

* `lineItemsSubtotalPrice`

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

  The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.

* `note`

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

  The note associated with the checkout.

* `paymentDue`

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

  The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards.

* `requiresShipping`

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

  States whether or not the fulfillment requires shipping.

* `shippingAddress`

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

  The shipping address to where the line items will be shipped.

* `shippingDiscountAllocations`

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

  The discounts that have been allocated onto the shipping line by discount applications.

* `shippingLine`

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

  Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

* `subtotalPrice`

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

  The price at checkout before duties, shipping, and taxes.

* `taxesIncluded`

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

  Whether taxes are included in the line item and shipping line prices.

* `totalPrice`

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

  The sum of all the prices of all the items in the checkout, including duties, taxes, and discounts.

* `totalTax`

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

  The sum of all the taxes applied to the line items and shipping lines in the checkout.

* `updatedAt`

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

  The date and time when the checkout was last updated.

* `webUrl`

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

  The url pointing to the checkout accessible from the web.

## Code Example

```graphql
 {
	checkout(id ) 
		 {
			# Checkout fields
		}
}
```

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/storefront-api/overview.md#status-and-error-codes).

