LineItem object
Represents a single line in a shopping cart.
Required access
read_orders
access scope.
On this page
Fields
-
contract (
SubscriptionContract
)The subscription contract associated with this line item.
-
currentQuantity (
Int!
)The line item's quantity minus the removed quantity.
-
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
-
sellingPlan (
LineItemSellingPlan
)The selling plan details associated with the line item.
-
sku (
String
)Variant SKU number.
-
taxLines (
[TaxLine!]!
)The TaxLine object connected to this line item.
Argument Description 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
-
LineItem.node
-
Order.lineItems
-
Order.nonFulfillableLineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return LineItem
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItem
Represents a single line in a shopping cart.
Required access
read_orders
access scope.
On this page
Fields
-
contract (
SubscriptionContract
)The subscription contract associated with this line item.
-
currentQuantity (
Int!
)The line item's quantity minus the removed quantity.
-
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
-
sellingPlan (
LineItemSellingPlan
)The selling plan details associated with the line item.
-
sku (
String
)Variant SKU number.
-
taxLines (
[TaxLine!]!
)The TaxLine object connected to this line item.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
Represents a single line in a shopping cart.
Required access
read_orders
access scope.
On this page
Fields
-
contract (
SubscriptionContract
)The subscription contract associated with this line item.
-
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
-
sellingPlan (
LineItemSellingPlan
)The selling plan details associated with the line item.
-
sku (
String
)Variant SKU number.
-
taxLines (
[TaxLine!]!
)The TaxLine object connected to this line item.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.
Types that return LineItemEdge
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.
-
duties (
[Duty!]!
)The duties associated with the line item.
-
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.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
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!
)The 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.
Argument Description 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.nonFulfillableLineItems
-
Order.lineItems
-
OrderStagedChangeDecrementItem.lineItem
-
OrderStagedChangeIncrementItem.lineItem
-
RefundLineItem.lineItem
Implements
Deprecated fields
-
canRestock (
Boolean!
) deprecatedWhether the line item's variant has an ID and inventory is managed by Shopify.
Deprecation warning
Use
restockable
instead -
discountedTotal (
Money!
) deprecatedThe total line price after discounts are applied.
Deprecation warning
Use
discountedTotalSet
instead -
discountedUnitPrice (
Money!
) deprecatedThe price of a single variant unit after line item discounts are applied.
Deprecation warning
Use
discountedUnitPriceSet
instead -
originalTotal (
Money!
) deprecatedTotal price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Deprecation warning
Use
originalTotalSet
instead -
originalUnitPrice (
Money!
) deprecatedVariant price without any discounts applied.
Deprecation warning
Use
originalUnitPriceSet
instead -
totalDiscount (
Money!
) deprecatedThe sum of all AppliedDiscounts on this line item.
Deprecation warning
Use
totalDiscountSet
instead -
unfulfilledDiscountedTotal (
Money!
) deprecatedThe total discounted value of unfulfilled units.
Deprecation warning
Use
unfulfilledDiscountedTotalSet
instead -
unfulfilledOriginalTotal (
Money!
) deprecatedThe total value before discount of all unfulfilled units.
Deprecation warning
Use
unfulfilledOriginalTotalSet
instead
An auto-generated type for paginating through multiple LineItems.
On this page
Fields
-
edges (
[LineItemEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one LineItem and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
LineItem!
)The item at the end of LineItemEdge.