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 OrderStagedChangeAddLineItemDiscount OrderStagedChangeAddLineItemDiscount •OBJECT: The discount applied to an item that was added during the current order edit.
Anchor to OrderStagedChangeAddShippingLine OrderStagedChangeAddShippingLine •OBJECT: A new shipping line added as part of an order edit.
Anchor to OrderStagedChangeAddVariant OrderStagedChangeAddVariant •OBJECT: A change to the order representing the addition of an existing product variant.
Anchor to OrderStagedChangeDecrementItem OrderStagedChangeDecrementItem •OBJECT: An removal of items from an existing line item on the order.
Anchor to OrderStagedChangeIncrementItem OrderStagedChangeIncrementItem •OBJECT: An addition of items to an existing line item on the order.
Anchor to OrderStagedChangeRemoveDiscount OrderStagedChangeRemoveDiscount •OBJECT: A discount application removed during an order edit.
Anchor to OrderStagedChangeRemoveShippingLine OrderStagedChangeRemoveShippingLine •OBJECT: A shipping line removed during an order edit.

Was this section helpful?

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