Anchor to orderEditBeginorder
mutationorder Edit Begin
Requires access scope.
Starts an order editing session that enables you to modify an existing Order. This mutation creates an and returns a showing how the order looks with your changes applied.
Order editing follows a three-step workflow: Begin the edit with , apply changes using mutations like or , and then save the changes with the mutation. The session tracks all staged changes until you commit or abandon them.
Learn more about editing existing orders.
Anchor to Arguments
Arguments
- id (ID!)
- •ID!required
The ID of the order to begin editing.
Was this section helpful?
- calculatedOrder (CalculatedOrder)
- orderEditSession (OrderEditSession)
- userErrors ([UserError!]!)
- Anchor to calculatedOrdercalculated•Calculated
Order Order The order that will be edited.
- Anchor to orderEditSessionorder•Order
Edit Session Edit Session The order edit session that was created.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Was this section helpful?