Skip to main content
Anchor to OrderStagedChange

OrderStagedChange

union

Requires read_order_edits access scope.

A change that has been applied to an order.

Anchor to Possible typesPossible types

Anchor to OrderStagedChangeAddCustomItemOrderStagedChangeAddCustomItem
•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.

Show fields
Anchor to OrderStagedChangeAddLineItemDiscountOrderStagedChangeAddLineItemDiscount
•OBJECT

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

Show fields
Anchor to OrderStagedChangeAddShippingLineOrderStagedChangeAddShippingLine
•OBJECT

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

Show fields
Anchor to OrderStagedChangeAddVariantOrderStagedChangeAddVariant
•OBJECT

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

Show fields
Anchor to OrderStagedChangeDecrementItemOrderStagedChangeDecrementItem
•OBJECT

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

Show fields
Anchor to OrderStagedChangeIncrementItemOrderStagedChangeIncrementItem
•OBJECT

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

Show fields
Anchor to OrderStagedChangeRemoveDiscountOrderStagedChangeRemoveDiscount
•OBJECT

A discount application removed during an order edit.

Show fields
Anchor to OrderStagedChangeRemoveShippingLineOrderStagedChangeRemoveShippingLine
•OBJECT

A shipping line removed during an order edit.

Show fields
Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to CalculatedLineItem.stagedChangesCalculatedLineItem.stagedChanges
•OBJECT

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

Anchor to CalculatedOrder.stagedChangesCalculatedOrder.stagedChanges
•OBJECT

An order during an active edit session with all proposed changes applied but not yet committed. When you begin editing an order with the orderEditBegin mutation, the system creates a CalculatedOrder that shows how the Order will look after your changes. The calculated order tracks the original order state and all staged modifications (added or removed LineItem objects, quantity adjustments, discount changes, and ShippingLine updates). Use the calculated order to preview the financial impact of edits before committing them with the orderEditCommit mutation.

Learn more about editing existing orders.

Anchor to OrderStagedChangeConnection.nodesOrderStagedChangeConnection.nodes
•CONNECTION

An auto-generated type for paginating through multiple OrderStagedChanges.

Anchor to OrderStagedChangeEdge.nodeOrderStagedChangeEdge.node
•OBJECT

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

Was this section helpful?