Calculated
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•[Calculated
Discount Allocations Discount Allocation!]! non-null The discounts that have been allocated onto the line item by discount applications.
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null A list of attributes that represent custom features or special requests.
- Anchor to discountedUnitPriceSetdiscounted•Money
Unit Price Set Bag! 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•Int!
Quantity non-null The total number of items that can be edited.
- Anchor to editableQuantityBeforeChangeseditable•Int!
Quantity Before Changes non-null The editable quantity prior to any changes made in the current edit.
- Anchor to editableSubtotalSeteditable•Money
Subtotal Set Bag! non-null The total price of editable lines in shop and presentment currencies.
- Anchor to hasStagedLineItemDiscounthas•Boolean!
Staged Line Item Discount non-null Whether the calculated line item has a staged discount.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image object associated to the line item's variant.
- Anchor to originalUnitPriceSetoriginal•Money
Unit Price Set Bag! 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.
- •String
The variant SKU number.
- Anchor to stagedChangesstaged•[Order
Changes Staged Change!]! non-null A list of changes that affect this line item.
- Anchor to titletitle•String!non-null
The title of the product.
- Anchor to uneditableSubtotalSetuneditable•Money
Subtotal Set Bag! non-null The total price of uneditable lines in shop and presentment currencies.
- Anchor to variantvariant•Product
Variant 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•String
Title The title of the variant.
- Anchor to discountAllocationsdiscount•[Discount
Allocations Allocation!]! non-nullDeprecated
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's being edited. Use this mutation to increase, decrease, or remove items by adjusting their quantities.
Setting the quantity to zero effectively removes the line item from the order. The item still exists as a data structure with zero quantity. When decreasing quantities, you can optionally restock the removed items to inventory by setting the
restockparameter totrue.Learn more about editing workflows for existing orders.
- •mutationDeprecated