OrderEditSession

The unique ID of the order edit session.

Returns a OrderEditSession resource by ID.

Adds a custom line item to an existing Order. Custom line items represent products or services not in your catalog, such as gift wrapping, installation fees, or one-off charges.

Creates a CalculatedLineItem with the specified title, price, and quantity. Changes remain in the edit session until you commit them with the orderEditCommit mutation.

Learn more about adding custom line items.

Applies a discount to a LineItem during an order edit session. The discount can be either a fixed amount or percentage value.

To modify pricing on specific line items, use this mutation after starting an order edit with the orderEditBegin mutation. The changes remain staged until you commit them with the orderEditCommit mutation.

Learn more about editing existing orders.

Adds a custom shipping line to an Order during an edit session. Specify the shipping title and price to create a new ShippingLine.

Returns a CalculatedOrder showing the order with edits applied but not yet saved. To save your changes, use the orderEditCommit mutation.

Learn more about editing existing orders.

Adds a ProductVariant as a line item to an Order that's being edited. The mutation respects the variant's contextual pricing.

You can specify a Location to check for inventory availability and control whether duplicate variants are allowed. The quantity must be a positive value.

Learn more about editing existing orders.

Starts an order editing session that enables you to modify an existing Order. This mutation creates an OrderEditSession and returns a CalculatedOrder showing how the order looks with your changes applied.

Order editing follows a three-step workflow: Begin the edit with orderEditBegin, apply changes using mutations like orderEditAddVariant or orderEditSetQuantity, and then save the changes with the orderEditCommit mutation. The session tracks all staged changes until you commit or abandon them.

Learn more about editing existing orders.

Removes a discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Removes a shipping line from an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Sets the quantity of a line item on an order that's being edited. Use this mutation to increase, decrease, or remove items by adjusting their quantities.

Setting the quantity to zero effectively removes the line item from the order. The item still exists as a data structure with zero quantity. When decreasing quantities, you can optionally restock the removed items to inventory by setting the restock parameter to true.

Learn more about editing workflows for existing orders.

Updates a manual line level discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Updates a shipping line on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.