orderEditBegin
mutation

Choose a version:

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 section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the order to begin editing.

Was this section helpful?

Anchor to section titled 'OrderEditBeginPayload returns'

OrderEditBeginPayload returns

Anchor to OrderEditBeginPayload.calculatedOrder calculatedOrder CalculatedOrder: The order that will be edited.
Anchor to OrderEditBeginPayload.orderEditSession orderEditSession OrderEditSession: The order edit session that was created.
Anchor to OrderEditBeginPayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditBegin

Query Reference for MUTATION: orderEditBegin

"mutation orderEditBegin($id: ID!) {\n  orderEditBegin(id: $id) {\n    calculatedOrder {\n      # CalculatedOrder fields\n    }\n    orderEditSession {\n      # OrderEditSession fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditBegin

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

Schema Reference for MUTATION: orderEditBegin

""

Display Examples for MUTATION: orderEditBegin

[]

orderEditBeginmutation

Arguments

OrderEditBeginPayload returns

orderEditBegin
mutation