Choose a version:

OrderStagedChange

union

Requires read_order_edits access scope.

A change that has been applied to an order.

Anchor to Possible typesPossible types

•

OBJECT

A change to the order representing the addition of a custom line item. For example, you might want to add gift wrapping service as a custom line item.

originalUnitPrice• MoneyV2! non-null: The price of an individual item without any discounts applied. This value can't be negative.
quantity• Int! non-null: The quantity of the custom item to add to the order. This value must be greater than zero.
title• String! non-null: The title of the custom item.

OrderStagedChangeAddLineItemDiscount

•

OBJECT

The discount applied to an item that was added during the current order edit.

description• String! non-null: The description of the discount.
id• ID! non-null: A globally-unique ID.
value• PricingValue! non-null: The pricing value of the discount.

OrderStagedChangeAddShippingLine

•

OBJECT

A new shipping line added as part of an order edit.

phone• String: The phone number at the shipping address.
presentmentTitle• String: The shipping line's title that's shown to the buyer.
price• MoneyV2! non-null: The price that applies to the shipping line.
title• String: The title of the shipping line.

OrderStagedChangeAddVariant

•

OBJECT

A change to the order representing the addition of an existing product variant.

quantity• Int! non-null: The quantity of the product variant that was added.
variant• ProductVariant! non-null: The product variant that was added.

OrderStagedChangeDecrementItem

•

OBJECT

An removal of items from an existing line item on the order.

delta• Int! non-null: The number of items removed.
lineItem• LineItem! non-null: The original line item.
restock• Boolean! non-null: The intention to restock the removed items.

OrderStagedChangeIncrementItem

•

OBJECT

An addition of items to an existing line item on the order.

delta• Int! non-null: The number of items added.
lineItem• LineItem! non-null: The original line item.

OrderStagedChangeRemoveShippingLine

•

OBJECT

A shipping line removed during an order edit.

shippingLine• ShippingLine! non-null: The removed shipping line.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to CalculatedLineItem.stagedChanges CalculatedLineItem.stagedChanges • OBJECT: A list of changes that affect this line item.
Anchor to CalculatedOrder.stagedChanges CalculatedOrder.stagedChanges • CONNECTION: List of changes made to the order during the current edit.
Anchor to OrderStagedChangeConnection.nodes OrderStagedChangeConnection.nodes • CONNECTION: A list of nodes that are contained in OrderStagedChangeEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to OrderStagedChangeEdge.node OrderStagedChangeEdge.node • OBJECT: The item at the end of OrderStagedChangeEdge.

Was this section helpful?