fulfillmentOrderSubmitCancellationRequest

mutation

Requires write_third_party_fulfillment_orders access scope. Also: The user must have fulfill_and_ship_orders permission.

Sends a cancellation request to the fulfillment service of a fulfillment order.

Arguments

Anchor to idid • ID!required: The ID of the fulfillment order associated with the cancellation request.
Anchor to messagemessage • String: An optional reason for the cancellation request.

Was this section helpful?

Anchor to FulfillmentOrderSubmitCancellationRequestPayload returnsFulfillmentOrderSubmitCancellationRequestPayload returns

Anchor to fulfillmentOrderfulfillmentOrder • FulfillmentOrder: The fulfillment order specified in the cancelation request.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Sends a cancellation request
fulfillmentOrderSubmitCancellationRequest reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation fulfillmentOrderSubmitCancellationRequest($id: ID!, $message: String) {

fulfillmentOrderSubmitCancellationRequest(id: $id, message: $message) {

fulfillmentOrder {

status

requestStatus

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/FulfillmentOrder/1046001469",

"message": "Customer cancelled their order"

);

const data = await response.json();

mutation fulfillmentOrderSubmitCancellationRequest($id: ID!, $message: String) {
  fulfillmentOrderSubmitCancellationRequest(id: $id, message: $message) {
    fulfillmentOrder {
      id
      status
      requestStatus
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderSubmitCancellationRequest($id: ID!, $message: String) { fulfillmentOrderSubmitCancellationRequest(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/FulfillmentOrder/1046001469",
    "message": "Customer cancelled their order"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation fulfillmentOrderSubmitCancellationRequest($id: ID!, $message: String) {
    fulfillmentOrderSubmitCancellationRequest(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/FulfillmentOrder/1046001469",
      "message": "Customer cancelled their order"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentOrderSubmitCancellationRequest($id: ID!, $message: String) {
      fulfillmentOrderSubmitCancellationRequest(id: $id, message: $message) {
        fulfillmentOrder {
          id
          status
          requestStatus
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/FulfillmentOrder/1046001469",
      "message": "Customer cancelled their order"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation fulfillmentOrderSubmitCancellationRequest($id: ID!, $message: String) {
    fulfillmentOrderSubmitCancellationRequest(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/FulfillmentOrder/1046001469",
  "message": "Customer cancelled their order"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/FulfillmentOrder/1046001469",

"message": "Customer cancelled their order"

}

Response

JSON

{

"fulfillmentOrderSubmitCancellationRequest": {

"fulfillmentOrder": {

"id": "gid://shopify/FulfillmentOrder/1046001469",

"status": "IN_PROGRESS",

"requestStatus": "ACCEPTED"

"userErrors": []

}