Skip to main content

CheckoutLine

Represents an item in the checkout.

type CheckoutLine implements Node, ObjectWithMetadata {
id: ID!
privateMetadata: [MetadataItem!]!
metadata: [MetadataItem!]!
isLinePriceOverridden: Boolean!
unitPriceOverriddenNote: String
note: String
variant: ProductVariant!
quantity: Int!
sale: Sale
totalPrice: TaxedMoney!
requiresShipping: Boolean
seller: Seller
discountedUnitPrice: TaxedMoney!
originalUnitPrice: TaxedMoney!
}

Fields

CheckoutLine.id ● ID! non-null scalar

The ID of the object

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

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

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

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

CheckoutLine.isLinePriceOverridden ● Boolean! non-null scalar

CheckoutLine.unitPriceOverriddenNote ● String scalar

CheckoutLine.note ● String scalar

CheckoutLine.variant ● ProductVariant! non-null object

CheckoutLine.quantity ● Int! non-null scalar

CheckoutLine.sale ● Sale object

CheckoutLine.totalPrice ● TaxedMoney! non-null object

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

CheckoutLine.requiresShipping ● Boolean scalar

Indicates whether the item need to be delivered.

CheckoutLine.seller ● Seller object

User info on the seller's underlying owner.

CheckoutLine.discountedUnitPrice ● TaxedMoney! non-null object

The unit price of line which is the discounted price after sale application

CheckoutLine.originalUnitPrice ● TaxedMoney! non-null object

Price of the single item in the checkout line before sales.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Member Of

Checkout object ● CheckoutLineAddNote object ● CheckoutLineCountableEdge object

Was this page helpful?