Skip to main content

CheckoutLine Object

Represents an item in the checkout.

type CheckoutLine implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  variant: ProductVariant!
  quantity: Int!
  unitPrice: TaxedMoney!
  undiscountedUnitPrice: Money!
  priorUnitPrice: Money
  totalPrice: TaxedMoney!
  undiscountedTotalPrice: Money!
  priorTotalPrice: Money
  requiresShipping: Boolean!
  problems: [CheckoutLineProblem!]
  isGift: Boolean
  priceOverrideReason: String
}

Fields​

id ● ID!​

The ID of the checkout line.

privateMetadata ● [MetadataItem!]!​

List of private metadata items. Requires staff permissions to access.

privateMetafield ● String​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

metadata ● [MetadataItem!]!​

List of public metadata items. Can be accessed without permissions.

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

variant ● ProductVariant!​

The product variant from which the checkout line was created.

quantity ● Int!​

The quantity of product variant assigned to the checkout line.

unitPrice ● TaxedMoney!​

The unit price of the checkout line, with taxes and discounts.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

undiscountedUnitPrice ● Money!​

The unit price of the checkout line, without discounts.

priorUnitPrice ● Money​

The unit price of the checkout line prior to promotion.

Added in Saleor 3.21

totalPrice ● TaxedMoney!​

The sum of the checkout line price, taxes and discounts.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

undiscountedTotalPrice ● Money!​

The sum of the checkout line price, without discounts.

priorTotalPrice ● Money​

The sum of the checkout line price prior to promotion.

Added in Saleor 3.21

requiresShipping ● Boolean!​

Indicates whether the item need to be delivered.

problems ● [CheckoutLineProblem!]​

List of problems with the checkout line.

isGift ● Boolean​

Determine if the line is a gift.

Added in Saleor 3.19
This API is currently in Feature Preview and can be subject to changes at later point.

priceOverrideReason ● String​

Reason explaining why a custom price was set on the line, provided by the app that set the price override.

Added in Saleor 3.23
Requires one of the following permissions: MANAGE_CHECKOUTSHANDLE_CHECKOUTS

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Member Of​

Checkout object ● CheckoutLineCountableEdge object ● CheckoutLineProblemInsufficientStock object ● CheckoutLineProblemVariantNotAvailable object

Implemented By​

TaxSourceLine union