CalculatedLineItem object

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

Required access

read_order_edits access scope.

On this page

Fields

  • calculatedDiscountAllocations ([[CalculatedDiscountAllocation!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddiscountallocation))
    The discounts that have been allocated onto the line item by discount applications.
  • customAttributes ([[Attribute!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/attribute))
    List of additional information (metafields) about the line item.
  • discountedUnitPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The total line price after discounts are applied in shop and presentment currencies.
  • editableQuantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The total number of items that can be edited.
  • editableQuantityBeforeChanges ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The editable quantity prior to any changes made in the current edit.
  • editableSubtotalSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The total price of editable lines in shop and presentment currencies.
  • hasStagedLineItemDiscount ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the calculated line item has a staged discount.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • image ([Image](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/image))
    The Image object associated to the line item’s variant.
  • originalUnitPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    Variant price without any discounts applied in shop and presentment currencies.
  • quantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The total number of items.
  • restockable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the line item can be restocked or not.
  • restocking ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the changes on the line item will result in a restock.
  • sku ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Variant SKU number.
  • stagedChanges ([[OrderStagedChange!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderstagedchange))
    A list of changes that affect this line item.
  • title ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Title of the product or variant.
  • uneditableSubtotalSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    The total price of uneditable lines in shop and presentment currencies.
  • variant ([ProductVariant](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    Name of the variant.

Types that return CalculatedLineItem

  • [CalculatedOrder.addedLineItems](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedorder#addedlineitems-2021-01)
  • [CalculatedOrder.lineItems](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedorder#lineitems-2021-01)

Deprecated fields

Show/Hide

An auto-generated type for paginating through multiple CalculatedLineItems.

On this page

Fields

  • edges ([[CalculatedLineItemEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

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

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([CalculatedLineItem!](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    The item at the end of CalculatedLineItemEdge.

Types that return CalculatedLineItemEdge

  • [CalculatedLineItemConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem#edges-2021-01)