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
}
Fields
CheckoutLine.id ● ID! non-null scalar miscellaneous
The ID of the checkout line.
CheckoutLine.privateMetadata ● [MetadataItem!]! non-null object miscellaneous
List of private metadata items. Requires staff permissions to access.
CheckoutLine.privateMetafield ● String scalar miscellaneous
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
CheckoutLine.privateMetafield.key ● String! non-null scalar miscellaneous
CheckoutLine.privateMetafields ● Metadata scalar miscellaneous
Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.
CheckoutLine.privateMetafields.keys ● [String!] list scalar miscellaneous
CheckoutLine.metadata ● [MetadataItem!]! non-null object miscellaneous
List of public metadata items. Can be accessed without permissions.
CheckoutLine.metafield ● String scalar miscellaneous
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
CheckoutLine.metafield.key ● String! non-null scalar miscellaneous
CheckoutLine.metafields ● Metadata scalar miscellaneous
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
CheckoutLine.metafields.keys ● [String!] list scalar miscellaneous
CheckoutLine.variant ● ProductVariant! non-null object products
The product variant from which the checkout line was created.
CheckoutLine.quantity ● Int! non-null scalar miscellaneous
The quantity of product variant assigned to the checkout line.
CheckoutLine.unitPrice ● TaxedMoney! non-null object miscellaneous
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 miscellaneous
The unit price of the checkout line, without discounts.
CheckoutLine.priorUnitPrice ● Money object miscellaneous
The unit price of the checkout line prior to promotion.
Added in Saleor 3.21 (unreleased)CheckoutLine.totalPrice ● TaxedMoney! non-null object miscellaneous
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 miscellaneous
The sum of the checkout line price, without discounts.
CheckoutLine.priorTotalPrice ● Money object miscellaneous
The sum of the checkout line price prior to promotion.
Added in Saleor 3.21 (unreleased)CheckoutLine.requiresShipping ● Boolean! non-null scalar miscellaneous
Indicates whether the item need to be delivered.
CheckoutLine.problems ● [CheckoutLineProblem!] list union miscellaneous
List of problems with the checkout line.
CheckoutLine.isGift ● Boolean scalar miscellaneous
Determine if the line is a gift.
Added in Saleor 3.19Interfaces
Node interface miscellaneous
An object with an ID
ObjectWithMetadata interface miscellaneous
Member Of
Checkout object ● CheckoutLineCountableEdge object ● CheckoutLineProblemInsufficientStock object ● CheckoutLineProblemVariantNotAvailable object
Implemented By
TaxSourceLine union