API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

LineItem object

Version unstable

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version unstable

An auto-generated type for paginating through multiple LineItems.

Fields

Types that return LineItem

Version unstable

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItem

Version 2021-07 (Release candidate)

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2021-07 (Release candidate)

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2021-04 (Latest)

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2021-04 (Latest)

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2021-04 (Latest)

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2021-01

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2021-01

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2021-01

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2020-10

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2020-10

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2020-10

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2020-07

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2020-07

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2020-07

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2020-04

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2020-04

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2020-04

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2020-01 (Unsupported)

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2020-01 (Unsupported)

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2019-10 (Unsupported)

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2019-10 (Unsupported)

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2019-07 (Unsupported)

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2019-07 (Unsupported)

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Version 2019-04 (Unsupported)

Represents a single line in a shopping cart.

Required access

read_orders access scope.

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 on Image.transformedSrc instead.
    maxHeight ( Int )

    Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
    maxWidth ( Int )

    Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    scale ( Int )

    Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.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

Implements

Deprecated fields

  • canRestock (Boolean!) deprecated

    Whether the line item's variant has an ID and inventory is managed by Shopify.

    Deprecation warning

    Use restockable instead

  • discountedTotal (Money!) deprecated

    The total line price after discounts are applied.

    Deprecation warning

    Use discountedTotalSet instead

  • discountedUnitPrice (Money!) deprecated

    The price of a single variant unit after line item discounts are applied.

    Deprecation warning

    Use discountedUnitPriceSet instead

  • originalTotal (Money!) deprecated

    Total 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!) deprecated

    Variant price without any discounts applied.

    Deprecation warning

    Use originalUnitPriceSet instead

  • totalDiscount (Money!) deprecated

    The sum of all AppliedDiscounts on this line item.

    Deprecation warning

    Use totalDiscountSet instead

  • unfulfilledDiscountedTotal (Money!) deprecated

    The total discounted value of unfulfilled units.

    Deprecation warning

    Use unfulfilledDiscountedTotalSet instead

  • unfulfilledOriginalTotal (Money!) deprecated

    The total value before discount of all unfulfilled units.

    Deprecation warning

    Use unfulfilledOriginalTotalSet instead

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple LineItems.

On this page

Fields

Version 2019-04 (Unsupported)

An auto-generated type which holds one LineItem and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (LineItem!)

    The item at the end of LineItemEdge.

Types that return LineItemEdge

Samples