Anchor to section titled 'undefined'fulfillment
fulfillment
mutation
2024-07
Requires write 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.
Anchor to section titled 'Arguments'
Arguments
The ID of the fulfillment order associated with the cancellation request.
- Anchor to messagemessage
An optional reason for accepting the cancellation request.
Was this section helpful?
Anchor to section titled 'FulfillmentOrderAcceptCancellationRequestPayload returns'
FulfillmentOrderAcceptCancellationRequestPayload returns
The fulfillment order whose cancellation request was accepted.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fulfillmentOrderAcceptCancellationRequest
Query Reference for MUTATION: fulfillmentOrderAcceptCancellationRequest
"mutation fulfillmentOrderAcceptCancellationRequest($id: ID!) {\n fulfillmentOrderAcceptCancellationRequest(id: $id) {\n fulfillmentOrder {\n # FulfillmentOrder fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fulfillmentOrderAcceptCancellationRequest
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"message\": \"<your-message>\"\n}"Schema Reference for MUTATION: fulfillmentOrderAcceptCancellationRequest
""
Display Examples for MUTATION: fulfillmentOrderAcceptCancellationRequest
[
{
"example": {
"type_name": "fulfillmentorderacceptcancellationrequest",
"title": "Accept a cancellation request",
"description": "A fulfillment service accepts a cancellation request for a fulfillment order that has already been accepted.",
"query_string": "mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/FulfillmentOrder/1046000790",
"message": "Fragile"
},
"response": {
"data": {
"fulfillmentOrderAcceptCancellationRequest": {
"fulfillmentOrder": {
"id": "gid://shopify/FulfillmentOrder/1046000790",
"status": "CANCELLED",
"requestStatus": "CANCELLATION_ACCEPTED"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_accept_cancellation_request_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) { fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000790\",\n \"message\": \"Fragile\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000790\",\n \"message\": \"Fragile\"\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000790\",\n \"message\": \"Fragile\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000790\",\n \"message\": \"Fragile\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation fulfillmentOrderAcceptCancellationRequest($id: ID!, $message: String) {\n fulfillmentOrderAcceptCancellationRequest(id: $id, message: $message) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/FulfillmentOrder/1046000790\",\n \"message\" => \"Fragile\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the fulfillment order associated with the cancellation request.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/FulfillmentOrder/1046000790\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "message",
"description": "An optional reason for accepting the cancellation request.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "String",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "message",
"argValue": " \"Fragile\"",
"typeKind": "MUTATION"
}
]
}
]