Calculated
Requires access scope.
An order with edits applied but not saved.
Anchor to Fields and connectionsFields and connections
- Anchor to addedDiscountApplicationsadded•
Discount Applications Returns only the new discount applications being added to the order in the current edit.
- Anchor to addedLineItemsadded•
Line Items CalculatedLine Item Connection!non-null Returns only the new line items being added to the order during the current edit.
- Anchor to cartDiscountAmountSetcart•
Discount Amount Set Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies.
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•
Items CalculatedLine Item Connection!non-null Returns all items on the order that existed before starting the edit. Will include any changes that have been made. Will not include line items added during the current edit.
- Anchor to notificationPreviewHtmlnotification•
Preview Html The HTML of the customer notification for the order edit.
- Anchor to notificationPreviewTitlenotification•
Preview Title String!non-null The customer notification title.
- Anchor to originalOrderoriginal•
Order Order!non-null The order without any changes applied.
- Anchor to shippingLinesshipping•
Lines [CalculatedShipping Line!]!non-null Returns the shipping lines on the order that existed before starting the edit. Will include any changes that have been made as well as shipping lines added during the current edit. Returns only the first 250 shipping lines.
- Anchor to stagedChangesstaged•
Changes OrderStaged Change Connection!non-null List of changes made to the order during the current edit.
- Anchor to subtotalLineItemsQuantitysubtotal•
Line Items Quantity Int!non-null The sum of the quantities for the line items that contribute to the order's subtotal.
- Anchor to subtotalPriceSetsubtotal•
Price Set The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal doesn't include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders.
- Anchor to taxLinestax•
Lines [TaxLine!]!non-null Taxes charged for the line item.
- Anchor to totalDutiestotal•
Duties Duties charged on the order.
- Anchor to totalOutstandingSettotal•
Outstanding Set MoneyBag!non-null Total price of the order less the total amount received from the customer in shop and presentment currencies.
- Anchor to totalPriceSettotal•
Price Set MoneyBag!non-null Total amount of the order (includes taxes and discounts) in shop and presentment currencies.
- Anchor to committedcommitted•Boolean!non-null
Whether the changes have been applied and saved to the order.
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 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•
Shipping Whether the custom item requires shipping. Defaults to
false.- •
The optional SKU for the custom item to add.
- Anchor to taxabletaxable•
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•
Specifies the weight unit and value inputs.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The custom line item that will be added to the order based on the current edits.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!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•
Item Id ID!required The ID of the calculated line item to add the discount to.
Arguments
- Anchor to addedDiscountStagedChangeadded•
Discount Staged Change The discount applied to a line item during this order edit.
- Anchor to calculatedLineItemcalculated•
Line Item The line item with the edits applied but not saved.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a shipping line to an existing order. 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. This is the edit to which the shipping line is added.
- Anchor to shippingLineshipping•
Line OrderEdit Add Shipping Line Input!required The shipping line to be added.
Arguments
- Anchor to calculatedOrdercalculated•
Order The calculated order with the edits applied but not saved.
- Anchor to calculatedShippingLinecalculated•
Shipping Line The calculated shipping line that's added during this order edit.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors 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•
Duplicates BooleanDefault:false 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 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 ID!required The ID of the variant to add.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The calculated line item that's added during this order edit.
- Anchor to calculatedOrdercalculated•
Order The calculated order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Starts editing an order. Mutations are operating on
. All order edits start with, have any number of* mutations made, and end with.- •ID!required
The ID of the order to begin editing.
Arguments
- Anchor to calculatedOrdercalculated•
Order The order that will be edited.
- Anchor to orderEditSessionorder•
Edit Session The order edit session that was created.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Removes a discount 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 discountApplicationIddiscount•
Application Id ID!required The ID of the calculated discount application to remove.
- •ID!required
The ID of the calculated order or the order edit session to edit. This is the edit from which the discount is removed.
Arguments
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes a shipping line from an existing order. 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. This is the edit from which the shipping line is removed.
- Anchor to shippingLineIdshipping•
Line Id ID!required The ID of the calculated shipping line to remove.
Arguments
- Anchor to calculatedOrdercalculated•
Order The calculated order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors 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•
Item Id ID!required The ID of the calculated line item to edit.
- Anchor to locationIdlocation•
Id The ID of the location. If 'restock' is set to true, the restocked item will be made available at the specified location.
- Anchor to quantityquantity•Int!required
The new quantity to set for the line item. This value cannot be negative.
- Anchor to restockrestock•
Whether or not to restock the line item when the updated quantity is less than the original quantity.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The calculated line item with the edits applied but not saved.
- Anchor to calculatedOrdercalculated•
Order The calculated order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Updates a manual line level discount 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 updated discount.
- Anchor to discountApplicationIddiscount•
Application Id ID!required The ID of the calculated discount application to update.
- •ID!required
The ID of the calculated order or the order edit session to edit. This is the edit used to update the discount.
Arguments
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a shipping line 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.
- •ID!required
The ID of the calculated order or the order edit session to edit. This is the edit used to update the shipping line.
- Anchor to shippingLineshipping•
Line The updated shipping line.
- Anchor to shippingLineIdshipping•
Line Id ID!required The ID of the calculated shipping line to update.
Arguments
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Removes a line item discount that was applied as part of an order edit.
- Anchor to discountApplicationIddiscount•
Application Id ID!required The ID of the calculated discount application to remove.
- •ID!required
The ID of the calculated order or the order edit session to edit. This is the edit from which the line item discount is removed.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The calculated line item after removal of the discount.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to orderEditSessionorder•
Edit Session The order edit session with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields