CalculatedOrder object

Version 2020-04 (Release candidate)

An order with edits applied but not saved.

Required access

read_order_edits access scope

Connections

addedLineItems (CalculatedLineItemConnection!)

Returns only the changes that resulted in new items being added to the order.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

lineItems (CalculatedLineItemConnection!)

Returns all items on the order that existed before starting the edit. will include any changes that have been made.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • editable

See the detailed search syntax.

reverse ( Boolean )

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

stagedChanges (OrderStagedChangeConnection!)

List of changes made on the order.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

Fields

cartDiscountAmountSet (MoneyBag)

Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.

committed (Boolean!)

Will be true when the changes have been applied to the order.

id (ID!)

Globally unique identifier.

notificationPreviewHtml (HTML)

The HTML of the customer notification for the order edit.

notificationPreviewTitle (String!)

The customer notification title.

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)

Subtotal of the line items and their discounts (does not contain shipping costs, shipping discounts, and order-level discounts) in shop and presentment currencies.

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.

Types that return CalculatedOrder

Implements

Deprecated fields

Show/Hide
order (Order!) deprecated

The order with changes applied.

Deprecation warning

Use originalOrder instead

Version 2020-01 (Latest)

An order with edits applied but not saved.

Required access

read_order_edits access scope

Connections

addedLineItems (CalculatedLineItemConnection!)

Returns only the changes that resulted in new items being added to the order.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

lineItems (CalculatedLineItemConnection!)

Returns all items on the order that existed before starting the edit. will include any changes that have been made.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • editable

See the detailed search syntax.

reverse ( Boolean )

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

stagedChanges (OrderStagedChangeConnection!)

List of changes made on the order.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

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

Fields

cartDiscountAmountSet (MoneyBag)

Amount of the order-level discount (does not contain any line item discounts) in shop and presentment currencies.

committed (Boolean!)

Will be true when the changes have been applied to the order.

id (ID!)

Globally unique identifier.

notificationPreviewHtml (HTML)

The HTML of the customer notification for the order edit.

notificationPreviewTitle (String!)

The customer notification title.

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)

Subtotal of the line items and their discounts (does not contain shipping costs, shipping discounts, and order-level discounts) in shop and presentment currencies.

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.

Types that return CalculatedOrder

Implements

Deprecated fields

Show/Hide
order (Order!) deprecated

The order with changes applied.

Deprecation warning

Use originalOrder instead