CalculatedOrder - admin-graphql - OBJECT

Version: 2024-01

Description:

An order with edits applied but not saved.

Access Scopes

`read_order_edits` access scope.

Fields

  • cartDiscountAmountSet: MoneyBag - Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies.
  • committed: Boolean! - Whether the changes have been applied and saved to the order.
  • id: ID! - A globally-unique ID.
  • notificationPreviewHtml: HTML - The HTML of the customer notification for the order edit.
  • notificationPreviewTitle: String! - The customer notification title.
  • order: Order! - The order without any changes applied.
  • originalOrder: Order! - The order without any changes applied.
  • subtotalLineItemsQuantity: Int! - The sum of the quantities for the line items that contribute to the order's subtotal.
  • subtotalPriceSet: 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.
  • taxLines: TaxLine! - Taxes charged for the line item.
  • totalOutstandingSet: MoneyBag! - Total price of the order less the total amount received from the customer in shop and presentment currencies.
  • totalPriceSet: MoneyBag! - Total amount of the order (includes taxes and discounts) in shop and presentment currencies.

Connections

  • addedDiscountApplications: CalculatedDiscountApplicationConnection!
  • addedLineItems: CalculatedLineItemConnection!
  • lineItems: CalculatedLineItemConnection!
  • stagedChanges: OrderStagedChangeConnection!

Related queries

Related mutations

  • orderEditAddCustomItem Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
  • orderEditAddLineItemDiscount 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
  • orderEditAddVariant Adds a line item from an existing product variant.
  • orderEditBegin 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`.
  • orderEditRemoveDiscount 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
  • orderEditRemoveLineItemDiscount Removes a line item discount that was applied as part of an order edit.
  • orderEditSetQuantity 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
  • orderEditUpdateDiscount 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

Related Unions

Examples