Skip to main content
Anchor to orderEditBegin

orderEditBegin

mutation

Requires write_order_edits access scope.

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 Arguments

Arguments

Anchor to idid
•
ID!required

The ID of the order to begin editing.

Was this section helpful?

Anchor to OrderEditBeginPayload returnsOrderEditBeginPayload returns

Anchor to calculatedOrdercalculatedOrder
•
CalculatedOrder

The order that will be edited.

Anchor to userErrorsuserErrors
•
[UserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?