Choose a version:

OrderEditSession

object

Requires read_order_edits access scope.

An edit session for an order.

Anchor to FieldsFields

Anchor to idid •ID! non-null: The unique ID of the order edit session.

Was this section helpful?

Anchor to QueriesQueries

Anchor to orderEditSession orderEditSession •query: Returns an Order editing session by order ID.

Was this section helpful?

Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a custom line item. To learn how to edit existing orders, refer to Edit an existing order with Admin API.

Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit to which the custom item is added.
Anchor to locationIdlocationId •ID: The ID of the retail location (if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided.
Anchor to priceprice •MoneyInput! required: The unit price of the custom item. This value can't be negative.
Anchor to quantityquantity •Int! required: The quantity of the custom item. This value must be greater than zero.
Anchor to requiresShippingrequiresShipping •Boolean: Whether the custom item requires shipping. Defaults to false.
Anchor to skusku •String: The optional SKU for the custom item to add.
Anchor to taxabletaxable •Boolean: Whether the custom item is taxable. Defaults to true.
Anchor to titletitle •String! required: The name of the custom item to add.
Anchor to weightweight •WeightInput: Specifies the weight unit and value inputs.

Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The custom line item that will be added to the order based on the current edits.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditAddLineItemDiscount

•mutation

Adds a discount to a line item 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.

Anchor to discountdiscount •OrderEditAppliedDiscountInput! required: The discount to add to the line item.
Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit.
Anchor to lineItemIdlineItemId •ID! required: The ID of the calculated line item to add the discount to.

Anchor to addedDiscountStagedChangeaddedDiscountStagedChange •OrderStagedChangeAddLineItemDiscount: The discount applied to a line item during this order edit.
Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The line item with the edits applied but not saved.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditAddShippingLine

•mutation

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

Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit to which the shipping line is added.
Anchor to shippingLineshippingLine •OrderEditAddShippingLineInput! required: The shipping line to be added.

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to calculatedShippingLinecalculatedShippingLine •CalculatedShippingLine: The calculated shipping line that's added during this order edit.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[OrderEditAddShippingLineUserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditAddVariant

•mutation

Adds a line item from an existing product variant. As of API version 2025-04, the orderEditAddVariant API will respect the contextual pricing of the variant.

Anchor to allowDuplicatesallowDuplicates •Boolean Default:false: Whether the mutation can create a line item for a variant that's already on the calculated order.
Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit.
Anchor to locationIdlocationId •ID: The ID of the location to check for inventory availability. A default location ID is chosen automatically if none is provided.
Anchor to quantityquantity •Int! required: The quantity of the item to add to the order. Must be a positive value.
Anchor to variantIdvariantId •ID! required: The ID of the variant to add.

Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The calculated line item that's added during this order edit.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditBegin

•mutation

Starts editing an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit.

Anchor to idid •ID! required: The ID of the order to begin editing.

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: The order that will be edited.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session that was created.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditRemoveDiscount

•mutation

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.

Anchor to discountApplicationIddiscountApplicationId •ID! required: The ID of the calculated discount application to remove.
Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit from which the discount is removed.

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[OrderEditRemoveDiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditRemoveShippingLine

•mutation

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.

Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit from which the shipping line is removed.
Anchor to shippingLineIdshippingLineId •ID! required: The ID of the calculated shipping line to remove.

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[OrderEditRemoveShippingLineUserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditSetQuantity

•mutation

Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. The edit changes the quantity on the line item.
Anchor to lineItemIdlineItemId •ID! required: The ID of the calculated line item to edit.
Anchor to locationIdlocationId •ID Deprecated
Anchor to quantityquantity •Int! required: The new quantity to set for the line item. This value cannot be negative.
Anchor to restockrestock •Boolean: Whether or not to restock the line item when the updated quantity is less than the original quantity.

Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The calculated line item with the edits applied but not saved.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditUpdateDiscount

•mutation

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.

Anchor to discountdiscount •OrderEditAppliedDiscountInput! required: The updated discount.
Anchor to discountApplicationIddiscountApplicationId •ID! required: The ID of the calculated discount application to update.
Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit used to update the discount.

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[OrderEditUpdateDiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditUpdateShippingLine

•mutation

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.

Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit used to update the shipping line.
Anchor to shippingLineshippingLine •OrderEditUpdateShippingLineInput! required: The updated shipping line.
Anchor to shippingLineIdshippingLineId •ID! required: The ID of the calculated shipping line to update.

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[OrderEditUpdateShippingLineUserError!]! non-null: The list of errors that occurred from executing the mutation.

orderEditRemoveLineItemDiscount

•mutation

Deprecated

Anchor to discountApplicationIddiscountApplicationId •ID! required: The ID of the calculated discount application to remove.
Anchor to idid •ID! required: The ID of the calculated order or the order edit session to edit. This is the edit from which the line item discount is removed.

Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The calculated line item after removal of the discount.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?

OrderEditSession

Anchor to FieldsFields

Anchor to QueriesQueries

Anchor to MutationsMutations

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Arguments

Fields

Anchor to InterfacesInterfaces