Calculated
Requires access scope.
An order with edits applied but not saved.
Anchor to FieldsFields
- Anchor to addedDiscountApplicationsadded•Calculated
Discount Applications Discount Application Connection! non-null Returns only the new discount applications being added to the order in the current edit.
- Anchor to addedLineItemsadded•Calculated
Line Items Line Item Connection! non-null Returns only the new line items being added to the order during the current edit.
- Anchor to cartDiscountAmountSetcart•Money
Discount Amount Set Bag 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•Calculated
Items Line 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•HTML
Preview Html The HTML of the customer notification for the order edit.
- Anchor to notificationPreviewTitlenotification•String!
Preview Title non-null The customer notification title.
- Anchor to originalOrderoriginal•Order!
Order non-null The order without any changes applied.
- Anchor to shippingLinesshipping•[Calculated
Lines Shipping 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•Order
Changes Staged Change Connection! non-null List of changes made to the order during the current edit.
- Anchor to subtotalLineItemsQuantitysubtotal•Int!
Line Items Quantity non-null The sum of the quantities for the line items that contribute to the order's subtotal.
- Anchor to subtotalPriceSetsubtotal•Money
Price Set Bag 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•[Tax
Lines Line!]! non-null Taxes charged for the line item.
- Anchor to totalOutstandingSettotal•Money
Outstanding Set Bag! non-null Total price of the order less the total amount received from the customer in shop and presentment currencies.
- Anchor to totalPriceSettotal•Money
Price Set Bag! non-null Total amount of the order (includes taxes and discounts) in shop and presentment currencies.
- Anchor to committedcommitted•Boolean!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 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.
- •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
Starts editing an order. Mutations are operating on
. All order edits start with, have any number of* mutations made, and end with.- •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.
- •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.
- •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.
- •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.
- •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.
- •mutationDeprecated