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?

Anchor to MutationsMutations

Anchor to orderEditAddCustomItem orderEditAddCustomItem • mutation: 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 orderEditAddLineItemDiscount 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 orderEditAddShippingLine 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 orderEditAddVariant 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 orderEditBegin 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 orderEditRemoveDiscount 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 orderEditRemoveShippingLine 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 orderEditSetQuantity 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 orderEditUpdateDiscount 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 orderEditUpdateShippingLine 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 orderEditRemoveLineItemDiscount orderEditRemoveLineItemDiscount • mutationDeprecated: Removes a line item discount that was applied as part of an order edit. Use orderEditRemoveDiscount instead.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?