CartLineItem

Describes a cart line item, including product details, pricing, and attributes.

Type Definition


type CartLineItem {
  type: String
  model: String
  image: String
  categoryPath: [String]
  lineDiscount: Float
  price: Float
  linePrice: Float
  netPrice: Float
  tax: Float
  quantity: Int
  title: String
  description: String
  attributesLabel: String
  attributes: [String]
  customizations: [CartLineCustomization]
  gtin: String
  manufacturer: String
  unit: String
  productUrl: String
  bundleItems: [CartLineItem]
  giftCardCode: String
  giftCardValue: Float
  giftCardExpiry: String
  product: Product
  rate: Float
  ratePercentage: Float
  id: Int
}

Fields

Field	Type	Description
type	String	Returns the type, either product, bundle or gift_card.
model	String	Returns the merchant defined model number.
image	String	Returns the image.
categoryPath	[String]	Returns the category path.
lineDiscount	Float	Returns the applied line discount in customer’s currency.
price	Float	Returns the unit price in customer’s currency.
linePrice	Float	Returns the line price in customer’s currency.
netPrice	Float	Returns the net price in customer’s currency.
tax	Float	Returns the line tax in customer’s currency.
quantity	Int	Returns the quantity.
title	String	Returns the title.
description	String	Returns the description.
attributesLabel	String	Returns a label for the attributes selected for the product.
attributes	[String]	Returns the attributes selected for the product.
customizations	[CartLineCustomization]	The customizations applied to this cart line item. For richer data than attributesLabel.
gtin	String	Returns a GTIN number for the product.
manufacturer	String	Returns the manufacturer.
unit	String	Returns a unit for the product.
productUrl	String	Returns the product url.
bundleItems	[CartLineItem]	Returns the bundle content if the type is bundle.
giftCardCode	String	Returns the gift card code if the type is gift_card.
giftCardValue	Float	Returns the gift card value in customer’s currency if the type is gift_card.
giftCardExpiry	String	Returns the gift card expiry date if the type is gift_card.
product	Product	Returns the associated product if it’s available at the store.
rate	Float	Returns the tax rate in decimals.
ratePercentage	Float	Returns the tax rate.
id	Int	The unique identifier of the cart item.

Relationships

CartLineItem represents individual items within a shopping cart. It contains details about products, bundles, and gift cards. Each line item includes pricing information (unit price, line price, taxes, and discounts), product attributes and customizations, and references to the associated Product object. For bundle-type items, CartLineItem recursively contains nested CartLineItem objects through the bundleItems field. Customizations are provided through CartLineCustomization objects for enhanced attribute data.

Example


{
  id
  type
  title
  description
  quantity
  price
  linePrice
  tax
  lineDiscount
  model
  gtin
  manufacturer
  image
  productUrl
  attributesLabel
  attributes
  customizations {
    key
    value
  }
  product {
    id
    name
  }
}

Implements

None