Choose a version:

orderRequestEdit

mutation

Requires customer_write_pre_authenticated access scope. Also: The user must have customer_write_orders access or be pre-authenticated for the queried order.

Request an edit to an order's unfulfilled line items on behalf of a customer.

Note

This mutation supports an optional idempotency key via the @idempotent directive. Supplying the same key for a retried request returns the originally created edit instead of creating a duplicate.

Anchor to Arguments

Arguments

Anchor to emailemail

•String

The email address to associate with the order if one doesn't exist.

Anchor to lineItemslineItems

•RequestedEditLineItemsInput!

required

The line item changes requested for the order, grouped by the type of change.

Anchor to orderIdorderId

•ID!

required

The ID of the order for which this edit is being requested.

Was this section helpful?

Anchor to OrderRequestEditPayload returnsOrderRequestEditPayload returns

Anchor to requestedEditrequestedEdit •RequestedEdit: The edit request that has been made.
Anchor to userErrorsuserErrors •[RequestedEditUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

orderRequestEdit reference

Mutation Reference

mutation orderRequestEdit($email: String, $lineItems: RequestedEditLineItemsInput!, $orderId: ID!) {

orderRequestEdit(email: $email, lineItems: $lineItems, orderId: $orderId) {

requestedEdit {

# RequestedEdit fields

}

userErrors {

field

message

}

Input

{

"email": "<your-email>",

"lineItems": {

"removals": [

{

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

"quantity": 1

}

]

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

}

Variables

{
  "email": "<your-email>",
  "lineItems": {
    "removals": [
      {
        "lineItemId": "gid://shopify/LineItem/10079785100",
        "quantity": 1
      }
    ]
  },
  "orderId": "gid://shopify/Order/10079785100"
}

Schema

input RequestedEditLineItemsInput {
  removals: [RequestedEditLineItemRemovalInput!]!
}

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