Choose a version:

requestedOrderEditCreate

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

•RequestedOrderEditCreateInput!

required

The input fields for creating a requested edit.

Was this section helpful?

Anchor to RequestedOrderEditCreatePayload returnsRequestedOrderEditCreatePayload returns

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

Was this section helpful?

Examples

requestedOrderEditCreate reference

Mutation Reference

mutation requestedOrderEditCreate($input: RequestedOrderEditCreateInput!) {

requestedOrderEditCreate(input: $input) {

requestedOrderEdit {

# RequestedOrderEdit fields

}

userErrors {

field

message

}

Input

{

"input": {

"lineItems": {

"removals": [

{}

]

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

}

Variables

{
  "input": {
    "lineItems": {
      "removals": [
        {}
      ]
    },
    "orderId": "gid://shopify/Order/10079785100"
  }
}

Schema

input RequestedOrderEditCreateInput {
  lineItems: RequestedOrderEditLineItemsInput!
  orderId: ID!
}

input RequestedOrderEditLineItemsInput {
  removals: [RequestedOrderEditLineItemRemovalInput!]!
}