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

CalculatedLineItem object

Version unstable

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • calculatedDiscountAllocations ([CalculatedDiscountAllocation!]!)

    The discounts that have been allocated onto the line item by discount applications.

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • hasStagedLineItemDiscount (Boolean!)

    Whether the calculated line item has a staged discount.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version unstable

An auto-generated type for paginating through multiple CalculatedLineItems.

Fields

Types that return CalculatedLineItem

Version unstable

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

Fields

Types that return CalculatedLineItem

Version 2021-04 (Release candidate)

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • calculatedDiscountAllocations ([CalculatedDiscountAllocation!]!)

    The discounts that have been allocated onto the line item by discount applications.

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • hasStagedLineItemDiscount (Boolean!)

    Whether the calculated line item has a staged discount.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2021-04 (Release candidate)

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2021-04 (Release candidate)

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

Fields

Types that return CalculatedLineItemEdge

Version 2021-01 (Latest)

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • calculatedDiscountAllocations ([CalculatedDiscountAllocation!]!)

    The discounts that have been allocated onto the line item by discount applications.

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • hasStagedLineItemDiscount (Boolean!)

    Whether the calculated line item has a staged discount.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2021-01 (Latest)

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2021-01 (Latest)

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

Fields

Types that return CalculatedLineItemEdge

Version 2020-10

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • calculatedDiscountAllocations ([CalculatedDiscountAllocation!]!)

    The discounts that have been allocated onto the line item by discount applications.

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • hasStagedLineItemDiscount (Boolean!)

    Whether the calculated line item has a staged discount.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2020-10

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2020-10

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

Fields

Types that return CalculatedLineItemEdge

Version 2020-07

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2020-07

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2020-07

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

Fields

Types that return CalculatedLineItemEdge

Version 2020-04

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2020-04

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2020-04

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

Fields

Types that return CalculatedLineItemEdge

Version 2020-01 (Unsupported)

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2020-01 (Unsupported)

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2020-01 (Unsupported)

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

Fields

Types that return CalculatedLineItemEdge

Version 2019-10 (Unsupported)

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2019-10 (Unsupported)

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2019-10 (Unsupported)

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

Fields

Types that return CalculatedLineItemEdge

Version 2019-07 (Unsupported)

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2019-07 (Unsupported)

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2019-07 (Unsupported)

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

Fields

Types that return CalculatedLineItemEdge

Version 2019-04 (Unsupported)

A line item involved in order editing that may be newly added or have new changes applied.

Required access

read_order_edits access scope.

Fields

  • customAttributes ([Attribute!]!)

    List of additional information (metafields) about the line item.

  • discountedUnitPriceSet (MoneyBag!)

    The total line price after discounts are applied in shop and presentment currencies.

  • editableQuantity (Int!)

    The total number of items that can be edited.

  • editableQuantityBeforeChanges (Int!)

    The editable quantity prior to any changes made in the current edit.

  • editableSubtotalSet (MoneyBag!)

    The total price of editable lines in shop and presentment currencies.

  • id (ID!)

    Globally unique identifier.

  • image (Image)

    The Image object associated to the line item's variant.

  • originalUnitPriceSet (MoneyBag!)

    Variant price without any discounts applied in shop and presentment currencies.

  • quantity (Int!)

    The total number of items.

  • restockable (Boolean!)

    Whether the line item can be restocked or not.

  • restocking (Boolean!)

    Whether the changes on the line item will result in a restock.

  • sku (String)

    Variant SKU number.

  • stagedChanges ([OrderStagedChange!]!)

    A list of changes that affect this line item.

  • title (String!)

    Title of the product or variant.

  • uneditableSubtotalSet (MoneyBag!)

    The total price of uneditable lines in shop and presentment currencies.

  • variant (ProductVariant)

    The product variant associated with this line item. Will be null for custom line items and items whose variant has been deleted.

  • variantTitle (String)

    Name of the variant.

Types that return CalculatedLineItem

Deprecated fields

  • discountAllocations ([DiscountAllocation!]!) deprecated

    The discounts that have been allocated onto the line item by discount applications.

    Deprecation warning

    Use calculatedDiscountAllocations instead

Version 2019-04 (Unsupported)

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

Version 2019-04 (Unsupported)

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

Fields

Types that return CalculatedLineItemEdge