CalculatedLineItem

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 FieldsFields

Anchor to calculatedDiscountAllocationscalculatedDiscountAllocations • [CalculatedDiscountAllocation!]!non-null: The discounts that have been allocated onto the line item by discount applications.
Anchor to customAttributescustomAttributes • [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.
Anchor to editableQuantityeditableQuantity • 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.
Anchor to editableSubtotalSeteditableSubtotalSet • 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.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to imageimage • 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.
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.
Anchor to skusku • String: The variant SKU number.
Anchor to stagedChangesstagedChanges • [OrderStagedChange!]!non-null: A list of changes that affect this line item.
Anchor to titletitle • 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.
Anchor to variantvariant • 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.
Anchor to variantTitlevariantTitle • String: The title of the variant.
Anchor to discountAllocationsdiscountAllocations • [DiscountAllocation!]!non-nullDeprecated: The discounts that have been allocated onto the line item by discount applications. Use calculatedDiscountAllocations instead.

Was this section helpful?

Anchor to MutationsMutations

Anchor to orderEditAddCustomItem orderEditAddCustomItem • 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.
Anchor to orderEditAddLineItemDiscount orderEditAddLineItemDiscount • 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.
Anchor to orderEditAddVariant orderEditAddVariant • 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.
Anchor to orderEditSetQuantity orderEditSetQuantity • 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.
Anchor to orderEditRemoveLineItemDiscount orderEditRemoveLineItemDiscount • mutationDeprecated: Removes a line item discount that was applied as part of an order edit. Use orderEditRemoveDiscount instead.

Was this section helpful?