LineItem object
Represents a single line in a shopping cart.
Required access
read_orders access scope
On this page
Fields
customAttributes
([Attribute!]!)
|
List of additional information (metafields) about the line item. |
discountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the line item by discount applications. |
discountedTotalSet
(MoneyBag!)
|
The total line price after discounts are applied in shop and presentment currencies. |
discountedUnitPriceSet
(MoneyBag!)
|
The price of a single variant unit after line item discounts are applied in shop and presentment currencies. |
fulfillableQuantity
(Int!)
|
The total number of units to fulfill. |
fulfillmentService
(FulfillmentService!)
|
Name of the service provider who fulfilled the order. Valid values are either manual or the name of the provider. For example, amazon, shipwire. |
fulfillmentStatus
(String!)
|
The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. |
id
(ID!)
|
Globally unique identifier. |
image
(Image)
|
The Image object associated to the line item's variant. |
crop
(
CropRegion
)
|
Crops the image according to the specified region. This argument is deprecated: Use |
maxHeight
(
Int
)
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
(
Int
)
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
scale
(
Int
)
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
merchantEditable
(Boolean!)
|
Whether the line item can be edited or not. |
name
(String!)
|
Name of the product. |
nonFulfillableQuantity
(Int!)
|
A count of the number of line items that cannot be fulfilled. |
originalTotalSet
(MoneyBag!)
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. |
originalUnitPriceSet
(MoneyBag!)
|
Variant price without any discounts applied in shop and presentment currencies. |
product
(Product)
|
The Product object associated with this line item's variant. |
quantity
(Int!)
|
Number of variant items ordered. |
refundableQuantity
(Int!)
|
The line item's quantity minus its refundedQuantity. |
requiresShipping
(Boolean!)
|
Whether physical shipping is required for the variant. |
restockable
(Boolean!)
|
Whether the line item's variant has an ID and inventory is managed by Shopify. |
sku
(String)
|
Variant SKU number. |
taxLines
([TaxLine!]!)
|
The TaxLine object connected to this line item. |
first
(
Int
)
|
Truncate the array result to this size. |
taxable
(Boolean!)
|
Whether the variant is taxable. |
title
(String!)
|
Title of the product or variant (this field only applies to custom line items). |
totalDiscountSet
(MoneyBag!)
|
The sum of all AppliedDiscounts on this line item in shop and presentment currencies. |
unfulfilledDiscountedTotalSet
(MoneyBag!)
|
The total discounted value of unfulfilled units in shop and presentment currencies. |
unfulfilledOriginalTotalSet
(MoneyBag!)
|
The total value before discount of all unfulfilled units in shop and presentment currencies. |
unfulfilledQuantity
(Int!)
|
The number of units not yet fulfilled. |
variant
(ProductVariant)
|
The Variant object associated with this line item. |
variantTitle
(String)
|
Name of the variant. |
vendor
(String)
|
Name of the vendor who made the variant. |
Types that return LineItem
-
DraftFulfillment.lineItems -
FulfillmentLineItem.lineItem -
FulfillmentOrderLineItem.lineItem -
Order.lineItems -
Order.nonFulfillableLineItems -
OrderStagedChangeDecrementItem.lineItem -
OrderStagedChangeIncrementItem.lineItem -
QueryRoot.node -
RefundLineItem.lineItem
Implements
Deprecated fields
Show/Hide
canRestock
(Boolean!)
deprecated
|
Whether the line item's variant has an ID and inventory is managed by Shopify. Deprecation warningUse |
discountedTotal
(Money!)
deprecated
|
The total line price after discounts are applied. Deprecation warningUse |
discountedUnitPrice
(Money!)
deprecated
|
The price of a single variant unit after line item discounts are applied. Deprecation warningUse |
originalTotal
(Money!)
deprecated
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. Deprecation warningUse |
originalUnitPrice
(Money!)
deprecated
|
Variant price without any discounts applied. Deprecation warningUse |
totalDiscount
(Money!)
deprecated
|
The sum of all AppliedDiscounts on this line item. Deprecation warningUse |
unfulfilledDiscountedTotal
(Money!)
deprecated
|
The total discounted value of unfulfilled units. Deprecation warningUse |
unfulfilledOriginalTotal
(Money!)
deprecated
|
The total value before discount of all unfulfilled units. Deprecation warningUse |
Represents a single line in a shopping cart.
Required access
read_orders access scope
On this page
Fields
customAttributes
([Attribute!]!)
|
List of additional information (metafields) about the line item. |
discountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the line item by discount applications. |
discountedTotalSet
(MoneyBag!)
|
The total line price after discounts are applied in shop and presentment currencies. |
discountedUnitPriceSet
(MoneyBag!)
|
The price of a single variant unit after line item discounts are applied in shop and presentment currencies. |
fulfillableQuantity
(Int!)
|
The total number of units to fulfill. |
fulfillmentService
(FulfillmentService!)
|
Name of the service provider who fulfilled the order. Valid values are either manual or the name of the provider. For example, amazon, shipwire. |
fulfillmentStatus
(String!)
|
The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. |
id
(ID!)
|
Globally unique identifier. |
image
(Image)
|
The Image object associated to the line item's variant. |
crop
(
CropRegion
)
|
Crops the image according to the specified region. This argument is deprecated: Use |
maxHeight
(
Int
)
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
(
Int
)
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
scale
(
Int
)
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
merchantEditable
(Boolean!)
|
Whether the line item can be edited or not. |
name
(String!)
|
Name of the product. |
nonFulfillableQuantity
(Int!)
|
A count of the number of line items that cannot be fulfilled. |
originalTotalSet
(MoneyBag!)
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. |
originalUnitPriceSet
(MoneyBag!)
|
Variant price without any discounts applied in shop and presentment currencies. |
product
(Product)
|
The Product object associated with this line item's variant. |
quantity
(Int!)
|
Number of variant items ordered. |
refundableQuantity
(Int!)
|
The line item's quantity minus its refundedQuantity. |
requiresShipping
(Boolean!)
|
Whether physical shipping is required for the variant. |
restockable
(Boolean!)
|
Whether the line item's variant has an ID and inventory is managed by Shopify. |
sku
(String)
|
Variant SKU number. |
taxLines
([TaxLine!]!)
|
The TaxLine object connected to this line item. |
first
(
Int
)
|
Truncate the array result to this size. |
taxable
(Boolean!)
|
Whether the variant is taxable. |
title
(String!)
|
Title of the product or variant (this field only applies to custom line items). |
totalDiscountSet
(MoneyBag!)
|
The sum of all AppliedDiscounts on this line item in shop and presentment currencies. |
unfulfilledDiscountedTotalSet
(MoneyBag!)
|
The total discounted value of unfulfilled units in shop and presentment currencies. |
unfulfilledOriginalTotalSet
(MoneyBag!)
|
The total value before discount of all unfulfilled units in shop and presentment currencies. |
unfulfilledQuantity
(Int!)
|
The number of units not yet fulfilled. |
variant
(ProductVariant)
|
The Variant object associated with this line item. |
variantTitle
(String)
|
Name of the variant. |
vendor
(String)
|
Name of the vendor who made the variant. |
Types that return LineItem
-
DraftFulfillment.lineItems -
FulfillmentLineItem.lineItem -
FulfillmentOrderLineItem.lineItem -
Order.lineItems -
Order.nonFulfillableLineItems -
OrderStagedChangeDecrementItem.lineItem -
OrderStagedChangeIncrementItem.lineItem -
QueryRoot.node -
RefundLineItem.lineItem
Implements
Deprecated fields
Show/Hide
canRestock
(Boolean!)
deprecated
|
Whether the line item's variant has an ID and inventory is managed by Shopify. Deprecation warningUse |
discountedTotal
(Money!)
deprecated
|
The total line price after discounts are applied. Deprecation warningUse |
discountedUnitPrice
(Money!)
deprecated
|
The price of a single variant unit after line item discounts are applied. Deprecation warningUse |
originalTotal
(Money!)
deprecated
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. Deprecation warningUse |
originalUnitPrice
(Money!)
deprecated
|
Variant price without any discounts applied. Deprecation warningUse |
totalDiscount
(Money!)
deprecated
|
The sum of all AppliedDiscounts on this line item. Deprecation warningUse |
unfulfilledDiscountedTotal
(Money!)
deprecated
|
The total discounted value of unfulfilled units. Deprecation warningUse |
unfulfilledOriginalTotal
(Money!)
deprecated
|
The total value before discount of all unfulfilled units. Deprecation warningUse |
Represents a single line in a shopping cart.
Required access
read_orders access scope
On this page
Fields
customAttributes
([Attribute!]!)
|
List of additional information (metafields) about the line item. |
discountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the line item by discount applications. |
discountedTotalSet
(MoneyBag!)
|
The total line price after discounts are applied in shop and presentment currencies. |
discountedUnitPriceSet
(MoneyBag!)
|
The price of a single variant unit after line item discounts are applied in shop and presentment currencies. |
fulfillableQuantity
(Int!)
|
The total number of units to fulfill. |
fulfillmentService
(FulfillmentService!)
|
Name of the service provider who fulfilled the order. Valid values are either manual or the name of the provider. For example, amazon, shipwire. |
fulfillmentStatus
(String!)
|
The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. |
id
(ID!)
|
Globally unique identifier. |
image
(Image)
|
The Image object associated to the line item's variant. |
crop
(
CropRegion
)
|
Crops the image according to the specified region. This argument is deprecated: Use |
maxHeight
(
Int
)
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
(
Int
)
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
scale
(
Int
)
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
merchantEditable
(Boolean!)
|
Whether the line item can be edited or not. |
name
(String!)
|
Name of the product. |
nonFulfillableQuantity
(Int!)
|
A count of the number of line items that cannot be fulfilled. |
originalTotalSet
(MoneyBag!)
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. |
originalUnitPriceSet
(MoneyBag!)
|
Variant price without any discounts applied in shop and presentment currencies. |
product
(Product)
|
The Product object associated with this line item's variant. |
quantity
(Int!)
|
Number of variant items ordered. |
refundableQuantity
(Int!)
|
The line item's quantity minus its refundedQuantity. |
requiresShipping
(Boolean!)
|
Whether physical shipping is required for the variant. |
restockable
(Boolean!)
|
Whether the line item's variant has an ID and inventory is managed by Shopify. |
sku
(String)
|
Variant SKU number. |
taxLines
([TaxLine!]!)
|
The TaxLine object connected to this line item. |
first
(
Int
)
|
Truncate the array result to this size. |
taxable
(Boolean!)
|
Whether the variant is taxable. |
title
(String!)
|
Title of the product or variant (this field only applies to custom line items). |
totalDiscountSet
(MoneyBag!)
|
The sum of all AppliedDiscounts on this line item in shop and presentment currencies. |
unfulfilledDiscountedTotalSet
(MoneyBag!)
|
The total discounted value of unfulfilled units in shop and presentment currencies. |
unfulfilledOriginalTotalSet
(MoneyBag!)
|
The total value before discount of all unfulfilled units in shop and presentment currencies. |
unfulfilledQuantity
(Int!)
|
The number of units not yet fulfilled. |
variant
(ProductVariant)
|
The Variant object associated with this line item. |
variantTitle
(String)
|
Name of the variant. |
vendor
(String)
|
Name of the vendor who made the variant. |
Types that return LineItem
-
DraftFulfillment.lineItems -
FulfillmentLineItem.lineItem -
Order.lineItems -
Order.nonFulfillableLineItems -
QueryRoot.node -
RefundLineItem.lineItem
Implements
Deprecated fields
Show/Hide
canRestock
(Boolean!)
deprecated
|
Whether the line item's variant has an ID and inventory is managed by Shopify. Deprecation warningUse |
discountedTotal
(Money!)
deprecated
|
The total line price after discounts are applied. Deprecation warningUse |
discountedUnitPrice
(Money!)
deprecated
|
The price of a single variant unit after line item discounts are applied. Deprecation warningUse |
originalTotal
(Money!)
deprecated
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. Deprecation warningUse |
originalUnitPrice
(Money!)
deprecated
|
Variant price without any discounts applied. Deprecation warningUse |
totalDiscount
(Money!)
deprecated
|
The sum of all AppliedDiscounts on this line item. Deprecation warningUse |
unfulfilledDiscountedTotal
(Money!)
deprecated
|
The total discounted value of unfulfilled units. Deprecation warningUse |
unfulfilledOriginalTotal
(Money!)
deprecated
|
The total value before discount of all unfulfilled units. Deprecation warningUse |
Represents a single line in a shopping cart.
Required access
read_orders access scope
On this page
Fields
customAttributes
([Attribute!]!)
|
List of additional information (metafields) about the line item. |
discountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the line item by discount applications. |
discountedTotalSet
(MoneyBag!)
|
The total line price after discounts are applied in shop and presentment currencies. |
discountedUnitPriceSet
(MoneyBag!)
|
The price of a single variant unit after line item discounts are applied in shop and presentment currencies. |
fulfillableQuantity
(Int!)
|
The total number of units to fulfill. |
fulfillmentService
(FulfillmentService!)
|
Name of the service provider who fulfilled the order. Valid values are either manual or the name of the provider. For example, amazon, shipwire. |
fulfillmentStatus
(String!)
|
The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. |
id
(ID!)
|
Globally unique identifier. |
image
(Image)
|
The Image object associated to the line item's variant. |
crop
(
CropRegion
)
|
Crops the image according to the specified region. This argument is deprecated: Use |
maxHeight
(
Int
)
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
(
Int
)
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
scale
(
Int
)
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
merchantEditable
(Boolean!)
|
Whether the line item can be edited or not. |
name
(String!)
|
Name of the product. |
nonFulfillableQuantity
(Int!)
|
A count of the number of line items that cannot be fulfilled. |
originalTotalSet
(MoneyBag!)
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. |
originalUnitPriceSet
(MoneyBag!)
|
Variant price without any discounts applied in shop and presentment currencies. |
product
(Product)
|
The Product object associated with this line item's variant. |
quantity
(Int!)
|
Number of variant items ordered. |
refundableQuantity
(Int!)
|
The line item's quantity minus its refundedQuantity. |
requiresShipping
(Boolean!)
|
Whether physical shipping is required for the variant. |
restockable
(Boolean!)
|
Whether the line item's variant has an ID and inventory is managed by Shopify. |
sku
(String)
|
Variant SKU number. |
taxLines
([TaxLine!]!)
|
The TaxLine object connected to this line item. |
first
(
Int
)
|
Truncate the array result to this size. |
taxable
(Boolean!)
|
Whether the variant is taxable. |
title
(String!)
|
Title of the product or variant (this field only applies to custom line items). |
totalDiscountSet
(MoneyBag!)
|
The sum of all AppliedDiscounts on this line item in shop and presentment currencies. |
unfulfilledDiscountedTotalSet
(MoneyBag!)
|
The total discounted value of unfulfilled units in shop and presentment currencies. |
unfulfilledOriginalTotalSet
(MoneyBag!)
|
The total value before discount of all unfulfilled units in shop and presentment currencies. |
unfulfilledQuantity
(Int!)
|
The number of units not yet fulfilled. |
variant
(ProductVariant)
|
The Variant object associated with this line item. |
variantTitle
(String)
|
Name of the variant. |
vendor
(String)
|
Name of the vendor who made the variant. |
Types that return LineItem
-
DraftFulfillment.lineItems -
FulfillmentLineItem.lineItem -
Order.lineItems -
Order.nonFulfillableLineItems -
QueryRoot.node -
RefundLineItem.lineItem
Implements
Deprecated fields
Show/Hide
canRestock
(Boolean!)
deprecated
|
Whether the line item's variant has an ID and inventory is managed by Shopify. Deprecation warningUse |
discountedTotal
(Money!)
deprecated
|
The total line price after discounts are applied. Deprecation warningUse |
discountedUnitPrice
(Money!)
deprecated
|
The price of a single variant unit after line item discounts are applied. Deprecation warningUse |
originalTotal
(Money!)
deprecated
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. Deprecation warningUse |
originalUnitPrice
(Money!)
deprecated
|
Variant price without any discounts applied. Deprecation warningUse |
totalDiscount
(Money!)
deprecated
|
The sum of all AppliedDiscounts on this line item. Deprecation warningUse |
unfulfilledDiscountedTotal
(Money!)
deprecated
|
The total discounted value of unfulfilled units. Deprecation warningUse |
unfulfilledOriginalTotal
(Money!)
deprecated
|
The total value before discount of all unfulfilled units. Deprecation warningUse |
Represents a single line in a shopping cart.
Required access
read_orders access scope
On this page
Fields
customAttributes
([Attribute!]!)
|
List of additional information (metafields) about the line item. |
discountAllocations
([DiscountAllocation!]!)
|
The discounts that have been allocated onto the line item by discount applications. |
discountedTotalSet
(MoneyBag!)
|
The total line price after discounts are applied in shop and presentment currencies. |
discountedUnitPriceSet
(MoneyBag!)
|
The price of a single variant unit after line item discounts are applied in shop and presentment currencies. |
fulfillableQuantity
(Int!)
|
The total number of units to fulfill. |
fulfillmentService
(FulfillmentService!)
|
Name of the service provider who fulfilled the order. Valid values are either manual or the name of the provider. For example, amazon, shipwire. |
fulfillmentStatus
(String!)
|
The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. |
id
(ID!)
|
Globally unique identifier. |
image
(Image)
|
The Image object associated to the line item's variant. |
crop
(
CropRegion
)
|
Crops the image according to the specified region. This argument is deprecated: Use |
maxHeight
(
Int
)
|
Image height in pixels between 1 and 2048. This argument is deprecated: Use |
maxWidth
(
Int
)
|
Image width in pixels between 1 and 2048. This argument is deprecated: Use |
scale
(
Int
)
|
Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use |
merchantEditable
(Boolean!)
|
Whether the line item can be edited or not. |
name
(String!)
|
Name of the product. |
nonFulfillableQuantity
(Int!)
|
A count of the number of line items that cannot be fulfilled. |
originalTotalSet
(MoneyBag!)
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity in shop and presentment currencies. |
originalUnitPriceSet
(MoneyBag!)
|
Variant price without any discounts applied in shop and presentment currencies. |
product
(Product)
|
The Product object associated with this line item's variant. |
quantity
(Int!)
|
Number of variant items ordered. |
refundableQuantity
(Int!)
|
The line item's quantity minus its refundedQuantity. |
requiresShipping
(Boolean!)
|
Whether physical shipping is required for the variant. |
restockable
(Boolean!)
|
Whether the line item's variant has an ID and inventory is managed by Shopify. |
sku
(String)
|
Variant SKU number. |
taxLines
([TaxLine!]!)
|
The TaxLine object connected to this line item. |
first
(
Int
)
|
Truncate the array result to this size. |
taxable
(Boolean!)
|
Whether the variant is taxable. |
title
(String!)
|
Title of the product or variant (this field only applies to custom line items). |
totalDiscountSet
(MoneyBag!)
|
The sum of all AppliedDiscounts on this line item in shop and presentment currencies. |
unfulfilledDiscountedTotalSet
(MoneyBag!)
|
The total discounted value of unfulfilled units in shop and presentment currencies. |
unfulfilledOriginalTotalSet
(MoneyBag!)
|
The total value before discount of all unfulfilled units in shop and presentment currencies. |
unfulfilledQuantity
(Int!)
|
The number of units not yet fulfilled. |
variant
(ProductVariant)
|
The Variant object associated with this line item. |
variantTitle
(String)
|
Name of the variant. |
vendor
(String)
|
Name of the vendor who made the variant. |
Types that return LineItem
-
DraftFulfillment.lineItems -
FulfillmentLineItem.lineItem -
Order.lineItems -
Order.nonFulfillableLineItems -
QueryRoot.node -
RefundLineItem.lineItem
Implements
Deprecated fields
Show/Hide
canRestock
(Boolean!)
deprecated
|
Whether the line item's variant has an ID and inventory is managed by Shopify. Deprecation warningUse |
discountedTotal
(Money!)
deprecated
|
The total line price after discounts are applied. Deprecation warningUse |
discountedUnitPrice
(Money!)
deprecated
|
The price of a single variant unit after line item discounts are applied. Deprecation warningUse |
originalTotal
(Money!)
deprecated
|
Total price (without discounts) of the line item, based on the original unit price of the variant x quantity. Deprecation warningUse |
originalUnitPrice
(Money!)
deprecated
|
Variant price without any discounts applied. Deprecation warningUse |
totalDiscount
(Money!)
deprecated
|
The sum of all AppliedDiscounts on this line item. Deprecation warningUse |
unfulfilledDiscountedTotal
(Money!)
deprecated
|
The total discounted value of unfulfilled units. Deprecation warningUse |
unfulfilledOriginalTotal
(Money!)
deprecated
|
The total value before discount of all unfulfilled units. Deprecation warningUse |