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!]!non-null
Attributes 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!non-null
Quantity The total number of items that can be edited.
- Anchor to editableQuantityBeforeChangeseditable•Int!non-null
Quantity Before Changes 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!non-null
Staged Line Item Discount 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 weightweight•Weight
The weight unit and value of the line item.
- 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.
- •ID!required
The ID of the calculated order or the order edit session to edit. This is the edit to which the custom item is added.
- Anchor to locationIdlocation•ID
Id The ID of the retail location (if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided.
- Anchor to priceprice•Money
Input!required The unit price of the custom item. This value can't be negative.
- Anchor to quantityquantity•Int!required
The quantity of the custom item. This value must be greater than zero.
- Anchor to requiresShippingrequires•Boolean
Shipping Whether the custom item requires shipping. Defaults to
false.- •String
The optional SKU for the custom item to add.
- Anchor to taxabletaxable•Boolean
Whether the custom item is taxable. Defaults to
true.- Anchor to titletitle•String!required
The name of the custom item to add.
- Anchor to weightweight•Weight
Input Specifies the weight unit and value inputs.
Arguments
- Anchor to calculatedLineItemcalculated•Calculated
Line Item Line Item The custom line item that will be added to the order based on the current edits.
- Anchor to calculatedOrdercalculated•Calculated
Order Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 discountdiscount•Order
Edit Applied Discount Input!required The discount to add to the line item.
- •ID!required
The ID of the calculated order or the order edit session to edit.
- Anchor to lineItemIdline•ID!required
Item Id The ID of the calculated line item to add the discount to.
Arguments
- Anchor to addedDiscountStagedChangeadded•Order
Discount Staged Change Staged Change Add Line Item Discount The discount applied to a line item during this order edit.
- Anchor to calculatedLineItemcalculated•Calculated
Line Item Line Item The line item with the edits applied but not saved.
- Anchor to calculatedOrdercalculated•Calculated
Order Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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 allowDuplicatesallow•BooleanDefault:false
Duplicates Whether the mutation can create a line item for a variant that's already on the calculated order.
- •ID!required
The ID of the calculated order or the order edit session to edit.
- Anchor to locationIdlocation•ID
Id The ID of the location to check for inventory availability. A default location ID is chosen automatically if none is provided.
- Anchor to quantityquantity•Int!required
The quantity of the item to add to the order. Must be a positive value.
- Anchor to variantIdvariant•ID!required
Id The ID of the variant to add.
Arguments
- Anchor to calculatedLineItemcalculated•Calculated
Line Item Line Item The calculated line item that's added during this order edit.
- Anchor to calculatedOrdercalculated•Calculated
Order Order The calculated order with the edits applied but not saved.
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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.
- •ID!required
The ID of the calculated order or the order edit session to edit. The edit changes the quantity on the line item.
- Anchor to lineItemIdline•ID!required
Item Id The ID of the calculated line item to edit.
- Anchor to locationIdlocation•IDDeprecated
Id - Anchor to quantityquantity•Int!required
The new quantity to set for the line item. This value cannot be negative.
- Anchor to restockrestock•Boolean
Whether or not to restock the line item when the updated quantity is less than the original quantity.
Arguments
- Anchor to calculatedLineItemcalculated•Calculated
Line Item Line Item The calculated line item with the edits applied but not saved.
- Anchor to calculatedOrdercalculated•Calculated
Order Order The calculated order with the edits applied but not saved.
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutationDeprecated