Skip to main content
Anchor to OrderEditBeginPayload

OrderEditBeginPayload

payload

Return type for orderEditBegin mutation.

•CalculatedOrder

The order that will be edited.

•OrderEditSession

The order edit session that was created.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

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.

Arguments

•ID!
required

The ID of the order to begin editing.



Was this section helpful?