Skip to main content

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!
}

Fields​

CheckoutLine.id ● ID! non-null scalar​

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

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

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

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
This API is currently in Feature Preview and can be subject to changes at later point.
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
This API is currently in Feature Preview and can be subject to changes at later point.
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
This API is currently in Feature Preview and can be subject to changes at later point.

CheckoutLine.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.
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
This API is currently in Feature Preview and can be subject to changes at later point.
CheckoutLine.metafields.keys ● [String!] list scalar​

CheckoutLine.variant ● ProductVariant! non-null object​

CheckoutLine.quantity ● Int! non-null scalar​

CheckoutLine.unitPrice ● TaxedMoney! non-null object​

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

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.

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.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

Checkout object

Was this page helpful?