Choose a version:

requestedEditCreate

mutation

Requires write_orders access scope. Also: The user must have edit_orders permission.

Creates a requested edit on an order on behalf of a buyer.

Anchor to Arguments

Arguments

Anchor to inputinput

•RequestedEditCreateInput!

required

The input fields for creating a requested edit.

Was this section helpful?

Anchor to RequestedEditCreatePayload returnsRequestedEditCreatePayload returns

Anchor to requestedEditrequestedEdit •RequestedEdit: The created requested edit.
Anchor to userErrorsuserErrors •[RequestedEditCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

requestedEditCreate reference

Mutation Reference

mutation requestedEditCreate($input: RequestedEditCreateInput!) {

requestedEditCreate(input: $input) {

requestedEdit {

# RequestedEdit fields

}

userErrors {

field

message

}

Input

{

"input": {

"orderId": "gid://shopify/Order/10079785100",

"requestedEditLineItems": [

{

"lineItemId": "gid://shopify/LineItem/10079785100",

"quantity": 1

}

]

}

Variables

{
  "input": {
    "orderId": "gid://shopify/Order/10079785100",
    "requestedEditLineItems": [
      {
        "lineItemId": "gid://shopify/LineItem/10079785100",
        "quantity": 1
      }
    ]
  }
}

Schema

input RequestedEditCreateInput {
  orderId: ID!
  requestedEditLineItems: [RequestedEditCreateLineItemInput!]!
}

input RequestedEditCreateLineItemInput {
  lineItemId: ID!
  quantity: Int!
}