Skip to main content
union

Requires read_order_edits access scope.

A change that has been applied to an order.

•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.

•MoneyV2!
non-null

The price of an individual item without any discounts applied. This value can't be negative.

•Int!
non-null

The quantity of the custom item to add to the order. This value must be greater than zero.

•String!
non-null

The title of the custom item.

•OBJECT

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

•String!
non-null

The description of the discount.

•ID!
non-null

A globally-unique ID.

•PricingValue!
non-null

The pricing value of the discount.

•OBJECT

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

•String

The phone number at the shipping address.

•String

The shipping line's title that's shown to the buyer.

•MoneyV2!
non-null

The price that applies to the shipping line.

•String

The title of the shipping line.

•OBJECT

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

•Int!
non-null

The quantity of the product variant that was added.

•ProductVariant!
non-null

The product variant that was added.

•OBJECT

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

•Int!
non-null

The number of items removed.

•LineItem!
non-null

The original line item.

•Boolean!
non-null

The intention to restock the removed items.

•OBJECT

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

•Int!
non-null

The number of items added.

•LineItem!
non-null

The original line item.

•OBJECT

A shipping line removed during an order edit.

•ShippingLine!
non-null

The removed shipping line.


Was this section helpful?

Anchor to Fields with this unionFields with this union

•OBJECT

A line item involved in order editing that may be newly added or have new changes applied.

•OBJECT

An order with edits applied but not saved.

•CONNECTION

An auto-generated type for paginating through multiple OrderStagedChanges.

•OBJECT

An auto-generated type which holds one OrderStagedChange and a cursor during pagination.


Was this section helpful?