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

Fields

id (ID!)

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

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

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

variant (ProductVariant!)

quantity (Int!)

unitPrice (TaxedMoney!)

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

undiscountedUnitPrice (Money!)

The unit price of the checkout line, without discounts.

totalPrice (TaxedMoney!)

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

undiscountedTotalPrice (Money!)

The sum of the checkout line price, without discounts.

requiresShipping (Boolean!)

Indicates whether the item need to be delivered.

Interfaces

Node

An object with an ID

ObjectWithMetadata