fulfillmentOrderAcceptCancellationRequest

mutation

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

Accept a cancellation request sent to a fulfillment service for 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 accepting the cancellation request.

Was this section helpful?

Anchor to FulfillmentOrderAcceptCancellationRequestPayload returnsFulfillmentOrderAcceptCancellationRequestPayload returns

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

Was this section helpful?

Accepts a cancellation request
fulfillmentOrderAcceptCancellationRequest reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {
6    fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {
7      fulfillmentOrder {
8        id
9        status
10        requestStatus
11      }
12      userErrors {
13        field
14        message
15      }
16    }
17  }`,
18  {
19    variables: {
20      "id": "gid://shopify/FulfillmentOrder/1046000777",
21      "message": "Fragile"
22    },
23  },
24);
25
26const data = await response.json();
27

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) { fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/FulfillmentOrder/1046000777",
    "message": "Fragile"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {
    fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/FulfillmentOrder/1046000777",
      "message": "Fragile"
    },
  },
);

const data = await response.json();

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

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 fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {
    fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/FulfillmentOrder/1046000777",
  "message": "Fragile"
}

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

Input variables

JSON

1{
2  "id": "gid://shopify/FulfillmentOrder/1046000777",
3  "message": "Fragile"
4}

Response

JSON

1{
2  "fulfillmentOrderAcceptCancellationRequest": {
3    "fulfillmentOrder": {
4      "id": "gid://shopify/FulfillmentOrder/1046000777",
5      "status": "CANCELLED",
6      "requestStatus": "CANCELLATION_ACCEPTED"
7    },
8    "userErrors": []
9  }
10}