CalculatedOrder

object

Requires read_order_edits access scope.

An order with edits applied but not saved.

Anchor to Fields and connectionsFields and connections

Anchor to addedDiscountApplicationsaddedDiscountApplications • CalculatedDiscountApplicationConnection!non-null: Returns only the new discount applications being added to the order in the current edit.
Anchor to addedLineItemsaddedLineItems • CalculatedLineItemConnection!non-null: Returns only the new line items being added to the order during the current edit.
Anchor to cartDiscountAmountSetcartDiscountAmountSet • MoneyBag: Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies.
Anchor to idid • ID!non-null: A globally-unique ID.
Anchor to lineItemslineItems • CalculatedLineItemConnection!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 notificationPreviewHtmlnotificationPreviewHtml • HTML: The HTML of the customer notification for the order edit.
Anchor to notificationPreviewTitlenotificationPreviewTitle • String!non-null: The customer notification title.
Anchor to originalOrderoriginalOrder • Order!non-null: The order without any changes applied.
Anchor to shippingLinesshippingLines • [CalculatedShippingLine!]!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 stagedChangesstagedChanges • OrderStagedChangeConnection!non-null: List of changes made to the order during the current edit.
Anchor to subtotalLineItemsQuantitysubtotalLineItemsQuantity • Int!non-null: The sum of the quantities for the line items that contribute to the order's subtotal.
Anchor to subtotalPriceSetsubtotalPriceSet • MoneyBag: 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 taxLinestaxLines • [TaxLine!]!non-null: Taxes charged for the line item.
Anchor to totalOutstandingSettotalOutstandingSet • MoneyBag!non-null: Total price of the order less the total amount received from the customer in shop and presentment currencies.
Anchor to totalPriceSettotalPriceSet • MoneyBag!non-null: Total amount of the order (includes taxes and discounts) in shop and presentment currencies.

Show

deprecated fields and connections Deprecated

Anchor to committedcommitted • Boolean!non-nullDeprecated: Whether the changes have been applied and saved to the order. CalculatedOrder for committed order edits is being deprecated, and this field will also be removed in a future version. See changelog for more details.
Anchor to orderorder • Order!non-nullDeprecated: The order without any changes applied. Use originalOrder 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 orderEditAddShippingLine orderEditAddShippingLine • 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.
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 orderEditBegin orderEditBegin • mutation: Starts editing an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit.
Anchor to orderEditRemoveDiscount orderEditRemoveDiscount • 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 orderEditRemoveShippingLine orderEditRemoveShippingLine • 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.
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 orderEditUpdateDiscount orderEditUpdateDiscount • 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 orderEditUpdateShippingLine orderEditUpdateShippingLine • 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.
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?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?