Skip to main content
object

Requires read_order_edits access scope.

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

Anchor to calculatedDiscountAllocationscalculatedDiscountAllocations
•[CalculatedDiscountAllocation!]!
non-null

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

•[Attribute!]!
non-null

A list of attributes that represent custom features or special requests.

Anchor to discountedUnitPriceSetdiscountedUnitPriceSet
•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.

•Int!
non-null

The total number of items that can be edited.

Anchor to editableQuantityBeforeChangeseditableQuantityBeforeChanges
•Int!
non-null

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

•MoneyBag!
non-null

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

Anchor to hasStagedLineItemDiscounthasStagedLineItemDiscount
•Boolean!
non-null

Whether the calculated line item has a staged discount.

•ID!
non-null

A globally-unique ID.

•Image

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

Anchor to originalUnitPriceSetoriginalUnitPriceSet
•MoneyBag!
non-null

The variant unit price in shop and presentment currencies, without any discounts applied.

•Int!
non-null

The total number of items.

•Boolean!
non-null

Whether the line item can be restocked or not.

•Boolean!
non-null

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

•String

The variant SKU number.

•[OrderStagedChange!]!
non-null

A list of changes that affect this line item.

•String!
non-null

The title of the product.

Anchor to uneditableSubtotalSetuneditableSubtotalSet
•MoneyBag!
non-null

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

•ProductVariant

The product variant associated with this line item. The value is null for custom line items and items where the variant has been deleted.

•String

The title of the variant.

•Weight

The weight unit and value of the line item.

•[DiscountAllocation!]!
non-nullDeprecated

Was this section helpful?

•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.


Was this section helpful?