Anchor to section titled 'undefined'fulfillment
fulfillment
mutation
Unstable
Requires write access scope or write access scope. Also: The user must have fulfill_and_ship_orders permission.
Marks a fulfillment order as canceled.
Anchor to section titled 'Arguments'
Arguments
The ID of the fulfillment order to mark as canceled.
Was this section helpful?
Anchor to section titled 'FulfillmentOrderCancelPayload returns'
FulfillmentOrderCancelPayload returns
The fulfillment order that was marked as canceled.
- Anchor to FulfillmentOrderCancelPayload.replacementFulfillmentOrderreplacement
Fulfillment Order The fulfillment order that was created to replace the canceled fulfillment order.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: fulfillmentOrderCancel
Query Reference for MUTATION: fulfillmentOrderCancel
"mutation fulfillmentOrderCancel($id: ID!) {\n fulfillmentOrderCancel(id: $id) {\n fulfillmentOrder {\n # FulfillmentOrder fields\n }\n replacementFulfillmentOrder {\n # FulfillmentOrder fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: fulfillmentOrderCancel
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: fulfillmentOrderCancel
""
Display Examples for MUTATION: fulfillmentOrderCancel
[
{
"example": {
"type_name": "fulfillmentordercancel",
"title": "Cancel a fulfillment order",
"description": "A merchant or order management app cancels a fulfillment order before it is accepted by a fulfillment service.",
"query_string": "mutation fulfillmentOrderCancel($id: ID!) {\n fulfillmentOrderCancel(id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n replacementFulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/FulfillmentOrder/1046000804"
},
"response": {
"data": {
"fulfillmentOrderCancel": {
"fulfillmentOrder": {
"id": "gid://shopify/FulfillmentOrder/1046000804",
"status": "CLOSED",
"requestStatus": "SUBMITTED"
},
"replacementFulfillmentOrder": {
"id": "gid://shopify/FulfillmentOrder/1046000805",
"status": "OPEN",
"requestStatus": "UNSUBMITTED"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_cancel_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrderCancel($id: ID!) { fulfillmentOrderCancel(id: $id) { fulfillmentOrder { id status requestStatus } replacementFulfillmentOrder { id status requestStatus } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000804\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fulfillmentOrderCancel($id: ID!) {\n fulfillmentOrderCancel(id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n replacementFulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000804\"\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 fulfillmentOrderCancel($id: ID!) {\n fulfillmentOrderCancel(id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n replacementFulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000804\"\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 fulfillmentOrderCancel($id: ID!) {\n fulfillmentOrderCancel(id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n replacementFulfillmentOrder {\n id\n status\n requestStatus\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000804\"\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 fulfillmentOrderCancel($id: ID!) {\n fulfillmentOrderCancel(id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n }\n replacementFulfillmentOrder {\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/1046000804\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the fulfillment order to mark as canceled.",
"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/1046000804\"",
"typeKind": "MUTATION"
}
]
}
]