fulfillmentOrderReleaseHold
mutation

Choose a version:

Requires write_merchant_managed_fulfillment_orders access scope, write_third_party_fulfillment_orders access scope or write_marketplace_fulfillment_orders access scope. Also: The user must have fulfill_and_ship_orders permission.

Releases the fulfillment hold on a fulfillment order.

Anchor to section titled 'Arguments'

Arguments

Anchor to externalId externalId String: A configurable ID used to track the automation system releasing this hold.
Anchor to holdIds holdIds [ID!]: The IDs of the fulfillment holds to release.

Holds will only be released if they belong to the fulfillment order specified by the id argument.

NOTE: If not supplied, all holds for the fulfillment order will be released. It is highly recommended that apps supply the ids of the holds that they intend to release. Releasing all holds on a fulfillment order will result in the fulfillment order being released prematurely and items being incorrectly fulfilled.
Anchor to id id ID! required: The ID of the fulfillment order for which to release the fulfillment hold.

Was this section helpful?

Anchor to section titled 'FulfillmentOrderReleaseHoldPayload returns'

FulfillmentOrderReleaseHoldPayload returns

Anchor to FulfillmentOrderReleaseHoldPayload.fulfillmentOrder fulfillmentOrder FulfillmentOrder: The fulfillment order on which the hold was released.
Anchor to FulfillmentOrderReleaseHoldPayload.userErrors userErrors [FulfillmentOrderReleaseHoldUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: fulfillmentOrderReleaseHold

Query Reference for MUTATION: fulfillmentOrderReleaseHold

"mutation fulfillmentOrderReleaseHold($id: ID!) {\n  fulfillmentOrderReleaseHold(id: $id) {\n    fulfillmentOrder {\n      # FulfillmentOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: fulfillmentOrderReleaseHold

"{\n  \"externalId\": \"<your-externalId>\",\n  \"holdIds\": [\n    \"gid://shopify/<objectName>/10079785100\"\n  ],\n  \"id\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: fulfillmentOrderReleaseHold

""

Display Examples for MUTATION: fulfillmentOrderReleaseHold

[
  {
    "example": {
      "type_name": "fulfillmentorderreleasehold",
      "title": "Release a hold on a fulfillment order",
      "description": "An app releases a hold on a fulfillment order.",
      "query_string": "mutation {\n  fulfillmentOrderReleaseHold(holdIds: [\"gid://shopify/FulfillmentHold/3\"], id: \"gid://shopify/FulfillmentOrder/564786110\") {\n    fulfillmentOrder {\n      id\n      status\n      requestStatus\n    }\n    userErrors {\n      field\n      message\n      code\n    }\n  }\n}",
      "response": {
        "data": {
          "fulfillmentOrderReleaseHold": {
            "fulfillmentOrder": {
              "id": "gid://shopify/FulfillmentOrder/564786110",
              "status": "OPEN",
              "requestStatus": "UNSUBMITTED"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-10",
      "maximum_api_version": "unstable",
      "location": "/components/fulfillments/test/unit/graph_api/admin/mutations/fulfillment_order_release_hold_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 { fulfillmentOrderReleaseHold(holdIds: [\\\"gid://shopify/FulfillmentHold/3\\\"], id: \\\"gid://shopify/FulfillmentOrder/564786110\\\") { fulfillmentOrder { id status requestStatus } userErrors { field message code } } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation {\n    fulfillmentOrderReleaseHold(holdIds: [\"gid://shopify/FulfillmentHold/3\"], id: \"gid://shopify/FulfillmentOrder/564786110\") {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n        code\n      }\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 {\n    fulfillmentOrderReleaseHold(holdIds: [\"gid://shopify/FulfillmentHold/3\"], id: \"gid://shopify/FulfillmentOrder/564786110\") {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `mutation {\n    fulfillmentOrderReleaseHold(holdIds: [\"gid://shopify/FulfillmentHold/3\"], id: \"gid://shopify/FulfillmentOrder/564786110\") {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n        code\n      }\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 {\n    fulfillmentOrderReleaseHold(holdIds: [\"gid://shopify/FulfillmentHold/3\"], id: \"gid://shopify/FulfillmentOrder/564786110\") {\n      fulfillmentOrder {\n        id\n        status\n        requestStatus\n      }\n      userErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "fulfillmentorderreleasehold",
      "title": "Release all holds on a fulfillment order",
      "description": "An app releases a fulfillment order.",
      "query_string": "mutation fulfillmentOrderReleaseHold($id: ID!) {\n  fulfillmentOrderReleaseHold(id: $id) {\n    fulfillmentOrder {\n      id\n      status\n      requestStatus\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/FulfillmentOrder/564786110"
      },
      "response": {
        "data": {
          "fulfillmentOrderReleaseHold": {
            "fulfillmentOrder": {
              "id": "gid://shopify/FulfillmentOrder/564786110",
              "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_release_hold_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 fulfillmentOrderReleaseHold($id: ID!) { fulfillmentOrderReleaseHold(id: $id) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/FulfillmentOrder/564786110\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation fulfillmentOrderReleaseHold($id: ID!) {\n    fulfillmentOrderReleaseHold(id: $id) {\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/564786110\"\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 fulfillmentOrderReleaseHold($id: ID!) {\n    fulfillmentOrderReleaseHold(id: $id) {\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/564786110\"\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 fulfillmentOrderReleaseHold($id: ID!) {\n      fulfillmentOrderReleaseHold(id: $id) {\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/564786110\"\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 fulfillmentOrderReleaseHold($id: ID!) {\n    fulfillmentOrderReleaseHold(id: $id) {\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/564786110\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "id",
          "description": "The ID of the fulfillment order for which to release the fulfillment hold.",
          "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/564786110\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

fulfillmentOrderReleaseHoldmutation

Arguments

FulfillmentOrderReleaseHoldPayload returns

fulfillmentOrderReleaseHold
mutation