CalculatedOrder object

An order with edits applied but not saved.

Required access

read_order_edits access scope.

On this page

Connections

  • addedDiscountApplications ([CalculatedDiscountApplicationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddiscountapplication))
    Returns only the new discount applications being added to the order.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
  • addedLineItems ([CalculatedLineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    Returns only the new line items being added to the order.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
  • lineItems ([CalculatedLineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    Returns all items on the order that existed before starting the edit. will include any changes that have been made.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
query
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Supported filter parameters:
+ editable
See the detailed search syntax for more information about using filters.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
  • stagedChanges ([OrderStagedChangeConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderstagedchange))
    List of changes made on the order.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false

Fields

  • cartDiscountAmountSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.
  • committed ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Will be true when the changes have been applied to the order.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • notificationPreviewHtml ([HTML](https://shopify.dev/docs/admin-api/graphql/reference/scalar#html-2021-01))
    The HTML of the customer notification for the order edit.
  • notificationPreviewTitle ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The customer notification title.
  • originalOrder ([Order!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
    The order without any changes applied.
  • subtotalLineItemsQuantity ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The sum of the quantities for the line items that contribute to the order’s subtotal.
  • subtotalPriceSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    Subtotal of the line items and their discounts (does not contain shipping costs, shipping discounts) in shop and presentment currencies.
  • taxLines ([[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline))
    Taxes charged for the line item.
  • totalOutstandingSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    Total price of the order less the total amount received from the customer in shop and presentment currencies.
  • totalPriceSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
    Total amount of the order (includes taxes and discounts) in shop and presentment currencies.

Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

  • order ([Order!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order)) DEPRECATED
    The order with changes applied.
    Deprecation warning
    Use originalOrder instead