CheckoutLine

Represents an item in the checkout.

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

Fields

CheckoutLine.id ● ID! non-null scalar

The Globally Unique ID of this object

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

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

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

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

CheckoutLine.quantity ● Int! non-null scalar

Quantity of this line item.

CheckoutLine.note ● String scalar

Note for this line item.

CheckoutLine.isLinePriceOverridden ● Boolean! non-null scalar

Whether the line price has been overridden.

CheckoutLine.unitPriceOverriddenNote ● String scalar

Note explaining the price override.

CheckoutLine.variant ● ProductVariant object

The product variant for this checkout line.

CheckoutLine.seller ● Seller object

The seller of this product.

CheckoutLine.sale ● Sale object

The sale applied to this line, if any.

CheckoutLine.totalPrice ● TaxedMoney! non-null object

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

CheckoutLine.discountedUnitPrice ● TaxedMoney! non-null object

The unit price after sale application (discounted price).

CheckoutLine.originalUnitPrice ● TaxedMoney! non-null object

Price of the single item before sales.

CheckoutLine.requiresShipping ● Boolean! non-null scalar

Indicates whether the item needs to be delivered.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Member Of

Checkout object ● CheckoutLineAddNote object ● CheckoutLineCountableEdge object