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.

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?

Mutation Reference

1mutation orderEditBegin($id: ID!) {
2  orderEditBegin(id: $id) {
3    calculatedOrder {
4      # CalculatedOrder fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100"
3}

{
  "id": "gid://shopify/<objectName>/10079785100"
}