Skip to main content
Version: 3.x

CheckoutLine

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!
  totalPrice: TaxedMoney!
  undiscountedTotalPrice: Money!
  requiresShipping: Boolean!
  problems: [CheckoutLineProblem!]
}

Fields​

CheckoutLine.id ● ID! non-null scalar​

The ID of the checkout line.

CheckoutLine.privateMetadata ● [MetadataItem!]! non-null object​

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

Added in Saleor 3.5

CheckoutLine.privateMetafield ● String scalar​

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.5
CheckoutLine.privateMetafield.key ● String! non-null scalar​

CheckoutLine.privateMetafields ● Metadata scalar​

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

Added in Saleor 3.5
CheckoutLine.privateMetafields.keys ● [String!] list scalar​

CheckoutLine.metadata ● [MetadataItem!]! non-null object​

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

Added in Saleor 3.5

CheckoutLine.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.5
CheckoutLine.metafield.key ● String! non-null scalar​

CheckoutLine.metafields ● Metadata scalar​

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

Added in Saleor 3.5
CheckoutLine.metafields.keys ● [String!] list scalar​

CheckoutLine.variant ● ProductVariant! non-null object​

The product variant from which the checkout line was created.

CheckoutLine.quantity ● Int! non-null scalar​

The quantity of product variant assigned to the checkout line.

CheckoutLine.unitPrice ● TaxedMoney! non-null object​

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.

CheckoutLine.undiscountedUnitPrice ● Money! non-null object​

The unit price of the checkout line, without discounts.

CheckoutLine.totalPrice ● TaxedMoney! non-null object​

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.

CheckoutLine.undiscountedTotalPrice ● Money! non-null object​

The sum of the checkout line price, without discounts.

CheckoutLine.requiresShipping ● Boolean! non-null scalar​

Indicates whether the item need to be delivered.

CheckoutLine.problems ● [CheckoutLineProblem!] list union​

List of problems with the checkout line.

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

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

Checkout object ● CheckoutLineCountableEdge object ● CheckoutLineProblemInsufficientStock object ● CheckoutLineProblemVariantNotAvailable object

Implemented by​

TaxSourceLine union

Was this page helpful?