fulfillment Order Closemutation
Requires write
access scope. Also: The user must have fulfill_and_ship_orders permission.
Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.
Arguments
The ID of the fulfillment order to mark as incomplete.
Anchor to messagemessageAn optional reason for marking the fulfillment order as incomplete.
FulfillmentOrderClosePayload returns
The fulfillment order that was marked as incomplete.
The list of errors that occurred from executing the mutation.
Code examples for MUTATION: fulfillmentOrderClose
Query Reference for MUTATION: fulfillmentOrderClose
"mutation fulfillmentOrderClose($id: ID!) {\n fulfillmentOrderClose(id: $id) {\n fulfillmentOrder {\n # FulfillmentOrder fields\n }\n userErrors {\n field\n message\n }\n }\n}"
Input Reference for MUTATION: fulfillmentOrderClose
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"message\": \"<your-message>\"\n}"
Schema Reference for MUTATION: fulfillmentOrderClose
""
Display Examples for MUTATION: fulfillmentOrderClose
[ { "example": { "type_name": "fulfillmentorderclose", "title": "Mark a fulfillment order as incomplete", "description": "A fulfillment app marks an accepted fulfillment order as incomplete.", "query_string": "mutation fulfillmentOrderClose($id: ID!, $message: String) {\n fulfillmentOrderClose(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/1046000803", "message": "Out of Stock" }, "response": { "data": { "fulfillmentOrderClose": { "fulfillmentOrder": { "id": "gid://shopify/FulfillmentOrder/1046000803", "status": "INCOMPLETE", "requestStatus": "CLOSED" }, "userErrors": [] } } }, "api_name": "admin", "minimum_api_version": "2023-10", "maximum_api_version": "unstable", "location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_close_test.rb", "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation fulfillmentOrderClose($id: ID!, $message: String) { fulfillmentOrderClose(id: $id, message: $message) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/FulfillmentOrder/1046000803\",\n \"message\": \"Out of Stock\"\n }\n}'\n", "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation fulfillmentOrderClose($id: ID!, $message: String) {\n fulfillmentOrderClose(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/1046000803\",\n \"message\": \"Out of Stock\"\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 fulfillmentOrderClose($id: ID!, $message: String) {\n fulfillmentOrderClose(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/1046000803\",\n \"message\": \"Out of Stock\"\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 fulfillmentOrderClose($id: ID!, $message: String) {\n fulfillmentOrderClose(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/1046000803\",\n \"message\": \"Out of Stock\"\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 fulfillmentOrderClose($id: ID!, $message: String) {\n fulfillmentOrderClose(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/1046000803\",\n \"message\" => \"Out of Stock\",\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 incomplete.", "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/1046000803\"", "typeKind": "MUTATION" }, { "arg": { "name": "message", "description": "An optional reason for marking the fulfillment order as incomplete.", "type": { "kind": "SCALAR", "name": "String", "list": false, "non_null": false }, "defaultValue": null, "typeSignature": "String", "isDeprecated": false, "deprecationReason": null, "kind": "ARGUMENT" }, "key": "message", "argValue": " \"Out of Stock\"", "typeKind": "MUTATION" } ] } ]