CalculatedLineItem
Requires access scope.
A line item involved in order editing that may be newly added or have new changes applied.
Anchor to FieldsFields
- Anchor to calculatedDiscountAllocationscalculated•
Discount Allocations [CalculatedDiscount non-nullAllocation!]! The discounts that have been allocated onto the line item by discount applications.
- Anchor to customAttributescustom•
Attributes [Attribute!]!non-null A list of attributes that represent custom features or special requests.
- Anchor to discountedUnitPriceSetdiscounted•
Unit Price Set MoneyBag! non-null The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price.
- Anchor to editableQuantityeditable•
Quantity Int!non-null The total number of items that can be edited.
- Anchor to editableQuantityBeforeChangeseditable•
Quantity Before Changes Int!non-null The editable quantity prior to any changes made in the current edit.
- Anchor to editableSubtotalSeteditable•
Subtotal Set MoneyBag! non-null The total price of editable lines in shop and presentment currencies.
- Anchor to hasStagedLineItemDiscounthas•
Staged Line Item Discount Boolean!non-null Whether the calculated line item has a staged discount.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•
The image object associated to the line item's variant.
- Anchor to originalUnitPriceSetoriginal•
Unit Price Set MoneyBag! non-null The variant unit price in shop and presentment currencies, without any discounts applied.
- Anchor to quantityquantity•Int!non-null
The total number of items.
- Anchor to restockablerestockable•Boolean!non-null
Whether the line item can be restocked or not.
- Anchor to restockingrestocking•Boolean!non-null
Whether the changes on the line item will result in a restock.
- •
The variant SKU number.
- Anchor to stagedChangesstaged•
Changes [OrderStaged non-nullChange!]! A list of changes that affect this line item.
- Anchor to titletitle•String!non-null
The title of the product.
- Anchor to uneditableSubtotalSetuneditable•
Subtotal Set MoneyBag! non-null The total price of uneditable lines in shop and presentment currencies.
- Anchor to variantvariant•
The product variant associated with this line item. The value is null for custom line items and items where the variant has been deleted.
- Anchor to variantTitlevariant•
Title The title of the variant.
- Anchor to discountAllocationsdiscount•
Allocations The discounts that have been allocated onto the line item by discount applications. Use
instead.
Anchor to MutationsMutations
- •mutation
Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a custom line item. To learn how to edit existing orders, refer to Edit an existing order with Admin API.
- •mutation
Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
- •mutation
Adds a line item from an existing product variant. As of API version 2025-04, the orderEditAddVariant API will respect the contextual pricing of the variant.
- •mutation
Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
- •mutationDeprecated
Removes a line item discount that was applied as part of an order edit. Use
instead.