Choose a version:

BaseCartLine

interface

Defines the shared fields for items in a shopping cart. Implemented by CartLine for individual merchandise and ComponentizableCartLine for grouped merchandise like bundles.

Each implementation includes the merchandise being purchased, quantity, cost breakdown, applied discounts, custom attributes, and any associated SellingPlan.

Anchor to FieldsFields

Anchor to attributeattribute

•Attribute

An attribute associated with the cart line.

Anchor to keykey •String! required: The key of the attribute.

Anchor to attributesattributes

•[Attribute!]!

non-null

The attributes associated with the cart line. Attributes are represented as key-value pairs.

Anchor to costcost

•CartLineCost!

non-null

The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.

Anchor to discountAllocationsdiscountAllocations

•[CartDiscountAllocation!]!

non-null

The discounts that have been applied to the cart line.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to merchandisemerchandise

•Merchandise!

non-null

The merchandise that the buyer intends to purchase.

Anchor to quantityquantity

•Int!

non-null

The quantity of the merchandise that the customer intends to purchase.

Anchor to sellingPlanAllocationsellingPlanAllocation

•SellingPlanAllocation

The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.

Anchor to estimatedCostestimatedCost

•CartLineEstimatedCost!

non-nullDeprecated

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CartLine CartLine

•OBJECT

An item in a customer's Cart representing a product variant they intend to purchase. Each cart line tracks the merchandise, quantity, cost breakdown, and any applied discounts.

Cart lines can include custom attributes for additional information like gift wrapping requests, and can be associated with a SellingPlanAllocation for purchase options like subscriptions, pre-orders, or try-before-you-buy. The instructions field indicates whether the line can be removed or have its quantity updated.

Anchor to attributeattribute

•Attribute

An attribute associated with the cart line.

Anchor to keykey •String! required: The key of the attribute.

Anchor to attributesattributes

•[Attribute!]!

non-null

The attributes associated with the cart line. Attributes are represented as key-value pairs.

Anchor to costcost

•CartLineCost!

non-null

The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.

Anchor to discountAllocationsdiscountAllocations

•[CartDiscountAllocation!]!

non-null

The discounts that have been applied to the cart line.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to instructionsinstructions

•CartLineInstructions!

non-null

The instructions for the line item.

Anchor to merchandisemerchandise

•Merchandise!

non-null

The merchandise that the buyer intends to purchase.

Anchor to parentRelationshipparentRelationship

•CartLineParentRelationship

The parent of the line item.

Anchor to quantityquantity

•Int!

non-null

The quantity of the merchandise that the customer intends to purchase.

Anchor to sellingPlanAllocationsellingPlanAllocation

•SellingPlanAllocation

The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.

Anchor to estimatedCostestimatedCost

•CartLineEstimatedCost!

non-nullDeprecated

Anchor to ComponentizableCartLine ComponentizableCartLine

•OBJECT

Represents information about the grouped merchandise in the cart.

Anchor to attributeattribute

•Attribute

An attribute associated with the cart line.

Anchor to keykey •String! required: The key of the attribute.

Anchor to attributesattributes

•[Attribute!]!

non-null

The attributes associated with the cart line. Attributes are represented as key-value pairs.

Anchor to costcost

•CartLineCost!

non-null

The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.

Anchor to discountAllocationsdiscountAllocations

•[CartDiscountAllocation!]!

non-null

The discounts that have been applied to the cart line.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to lineComponentslineComponents

•[CartLine!]!

non-null

The components of the line item.

Anchor to merchandisemerchandise

•Merchandise!

non-null

The merchandise that the buyer intends to purchase.

Anchor to quantityquantity

•Int!

non-null

The quantity of the merchandise that the customer intends to purchase.

Anchor to sellingPlanAllocationsellingPlanAllocation

•SellingPlanAllocation

The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.

Anchor to estimatedCostestimatedCost

•CartLineEstimatedCost!

non-nullDeprecated

Was this section helpful?

{

"attribute": {

"key": ""

"attributes": "",

"cost": "",

"discountAllocations": "",

"estimatedCost": "",

"id": "",

"merchandise": "",

"quantity": "",

"sellingPlanAllocation": ""

}

Variables

{
	"attribute": {
		"key": ""
	},
	"attributes": "",
	"cost": "",
	"discountAllocations": "",
	"estimatedCost": "",
	"id": "",
	"merchandise": "",
	"quantity": "",
	"sellingPlanAllocation": ""
}

Schema

interface BaseCartLine {
  attribute: Attribute
  attributes: [Attribute!]!
  cost: CartLineCost!
  discountAllocations: [CartDiscountAllocation!]!
  estimatedCost: CartLineEstimatedCost!
  id: ID!
  merchandise: Merchandise!
  quantity: Int!
  sellingPlanAllocation: SellingPlanAllocation
}

BaseCartLine

Anchor to FieldsFields

Arguments

Anchor to Types implemented inTypes implemented in

Arguments

Arguments