# fulfillmentOrderHold - admin-graphql - MUTATION Version: 2024-10 ## Description Applies a fulfillment hold on a fulfillment order. As of the [2025-01 API version](https://shopify.dev/changelog/apply-multiple-holds-to-a-single-fulfillment-order), the mutation can be successfully executed on fulfillment orders that are already on hold. To place multiple holds on a fulfillment order, apps need to supply the [handle](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentHold#field-handle) field. Each app can place up to 10 active holds per fulfillment order. If an app attempts to place more than this, the mutation will return [a user error indicating that the limit has been reached](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderHoldUserErrorCode#value-fulfillmentorderholdlimitreached). The app would need to release one of its existing holds before being able to apply a new one. ### 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 * [fulfillmentHold](/docs/api/admin-graphql/2024-10/input-objects/FulfillmentOrderHoldInput): FulfillmentOrderHoldInput! - The details of the fulfillment hold applied on the fulfillment order. * [id](/docs/api/admin-graphql/2024-10/scalars/ID): ID! - The ID of the fulfillment order on which a fulfillment hold is applied. ## Returns * [fulfillmentHold](/docs/api/admin-graphql/2024-10/objects/FulfillmentHold): FulfillmentHold The fulfillment hold created for the fulfillment order. Null if no hold was created. * [fulfillmentOrder](/docs/api/admin-graphql/2024-10/objects/FulfillmentOrder): FulfillmentOrder The fulfillment order on which a fulfillment hold was applied. * [remainingFulfillmentOrder](/docs/api/admin-graphql/2024-10/objects/FulfillmentOrder): FulfillmentOrder The remaining fulfillment order containing the line items to which the hold wasn't applied, if specific line items were specified to be placed on hold. * [userErrors](/docs/api/admin-graphql/2024-10/objects/FulfillmentOrderHoldUserError): FulfillmentOrderHoldUserError! The list of errors that occurred from executing the mutation. ## Examples ### Applies a fulfillment hold on an open fulfillment order 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 FulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) { fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) { fulfillmentOrder { id } remainingFulfillmentOrder { id } userErrors { field message } } }\",\n \"variables\": {\n \"fulfillmentHold\": {\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001479\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation FulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n }\n remainingFulfillmentOrder {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"fulfillmentHold\": {\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001479\"\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 FulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n }\n remainingFulfillmentOrder {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"fulfillmentHold\": {\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001479\"\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 FulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n }\n remainingFulfillmentOrder {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"fulfillmentHold\": {\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001479\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation FulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n }\n remainingFulfillmentOrder {\n id\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "fulfillmentHold": { "reason": "INVENTORY_OUT_OF_STOCK", "reasonNotes": "Waiting on new shipment" }, "id": "gid://shopify/FulfillmentOrder/1046001479" } #### Graphql Response { "data": { "fulfillmentOrderHold": { "fulfillmentOrder": { "id": "gid://shopify/FulfillmentOrder/1046001479" }, "remainingFulfillmentOrder": null, "userErrors": [] } } } ### Put a fulfillment order on hold 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 fulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) { fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) { fulfillmentOrder { id status requestStatus fulfillmentHolds { reason reasonNotes } } userErrors { field message } } }\",\n \"variables\": {\n \"fulfillmentHold\": {\n \"notifyMerchant\": true,\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001480\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation fulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n fulfillmentHolds {\n reason\n reasonNotes\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"fulfillmentHold\": {\n \"notifyMerchant\": true,\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001480\"\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 fulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n fulfillmentHolds {\n reason\n reasonNotes\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"fulfillmentHold\": {\n \"notifyMerchant\": true,\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001480\"\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 fulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n fulfillmentHolds {\n reason\n reasonNotes\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"fulfillmentHold\": {\n \"notifyMerchant\": true,\n \"reason\": \"INVENTORY_OUT_OF_STOCK\",\n \"reasonNotes\": \"Waiting on new shipment\"\n },\n \"id\": \"gid://shopify/FulfillmentOrder/1046001480\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation fulfillmentOrderHold($fulfillmentHold: FulfillmentOrderHoldInput!, $id: ID!) {\n fulfillmentOrderHold(fulfillmentHold: $fulfillmentHold, id: $id) {\n fulfillmentOrder {\n id\n status\n requestStatus\n fulfillmentHolds {\n reason\n reasonNotes\n }\n }\n userErrors {\n field\n message\n }\n }\n}" #### Graphql Input { "fulfillmentHold": { "notifyMerchant": true, "reason": "INVENTORY_OUT_OF_STOCK", "reasonNotes": "Waiting on new shipment" }, "id": "gid://shopify/FulfillmentOrder/1046001480" } #### Graphql Response { "data": { "fulfillmentOrderHold": { "fulfillmentOrder": { "id": "gid://shopify/FulfillmentOrder/1046001480", "status": "ON_HOLD", "requestStatus": "UNSUBMITTED", "fulfillmentHolds": [ { "reason": "INVENTORY_OUT_OF_STOCK", "reasonNotes": "Waiting on new shipment" } ] }, "userErrors": [] } } }