# fulfillmentOrderCancel - admin-graphql - MUTATION Version: 2024-07 ## Description Marks a fulfillment order as canceled. ### Access Scopes `write_merchant_managed_fulfillment_orders` access scope or `write_third_party_fulfillment_orders` access scope. Also: The user must have fulfill_and_ship_orders permission. ## Arguments * [id](/docs/api/admin-graphql/2024-07/scalars/ID): ID! - The ID of the fulfillment order to mark as canceled. ## Returns * [fulfillmentOrder](/docs/api/admin-graphql/2024-07/objects/FulfillmentOrder): FulfillmentOrder The fulfillment order that was marked as canceled. * [replacementFulfillmentOrder](/docs/api/admin-graphql/2024-07/objects/FulfillmentOrder): FulfillmentOrder The fulfillment order that was created to replace the canceled fulfillment order. * [userErrors](/docs/api/admin-graphql/2024-07/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Cancel a fulfillment order 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 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" 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" 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" 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" Graphql 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}" #### Graphql Input { "id": "gid://shopify/FulfillmentOrder/1046000804" } #### Graphql Response { "data": { "fulfillmentOrderCancel": { "fulfillmentOrder": { "id": "gid://shopify/FulfillmentOrder/1046000804", "status": "CLOSED", "requestStatus": "SUBMITTED" }, "replacementFulfillmentOrder": { "id": "gid://shopify/FulfillmentOrder/1046000805", "status": "OPEN", "requestStatus": "UNSUBMITTED" }, "userErrors": [] } } }