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

Anchor to OrderStagedChangeAddCustomItem OrderStagedChangeAddCustomItem

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

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

Anchor to OrderStagedChangeAddLineItemDiscount OrderStagedChangeAddLineItemDiscount

•OBJECT

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

Anchor to descriptiondescription •String! non-null: The description of the discount.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to valuevalue •PricingValue! non-null: The pricing value of the discount.

Anchor to OrderStagedChangeAddShippingLine OrderStagedChangeAddShippingLine

•OBJECT

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

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

Anchor to OrderStagedChangeAddVariant OrderStagedChangeAddVariant

•OBJECT

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

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

Anchor to OrderStagedChangeDecrementItem OrderStagedChangeDecrementItem

•OBJECT

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

Anchor to deltadelta •Int! non-null: The number of items removed.
Anchor to lineItemlineItem •LineItem! non-null: The original line item.
Anchor to restockrestock •Boolean! non-null: The intention to restock the removed items.

Anchor to OrderStagedChangeIncrementItem OrderStagedChangeIncrementItem

•OBJECT

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

Anchor to deltadelta •Int! non-null: The number of items added.
Anchor to lineItemlineItem •LineItem! non-null: The original line item.

Anchor to OrderStagedChangeRemoveShippingLine OrderStagedChangeRemoveShippingLine

•OBJECT

A shipping line removed during an order edit.

Anchor to shippingLineshippingLine •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 line item involved in order editing that may be newly added or have new changes applied.
Anchor to CalculatedOrder.stagedChanges CalculatedOrder.stagedChanges •OBJECT: An order with edits applied but not saved.
Anchor to OrderStagedChangeConnection.nodes OrderStagedChangeConnection.nodes •CONNECTION: An auto-generated type for paginating through multiple OrderStagedChanges.
Anchor to OrderStagedChangeEdge.node OrderStagedChangeEdge.node •OBJECT: An auto-generated type which holds one OrderStagedChange and a cursor during pagination.

Was this section helpful?