fulfillmentOrderReleaseHold

mutation

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.

Arguments

Anchor to externalIdexternalId • String: A configurable ID used to track the automation system releasing this hold.
Anchor to holdIdsholdIds • [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 idid • ID!required: The ID of the fulfillment order for which to release the fulfillment hold.

Was this section helpful?

Anchor to FulfillmentOrderReleaseHoldPayload returnsFulfillmentOrderReleaseHoldPayload returns

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

Was this section helpful?

Release all holds on a fulfillment order
Releases the fulfillment hold on a fulfillment order
fulfillmentOrderReleaseHold reference

Examples

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation fulfillmentOrderReleaseHold($id: ID!) {

fulfillmentOrderReleaseHold(id: $id) {

fulfillmentOrder {

status

requestStatus

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/FulfillmentOrder/564786110"

);

const data = await response.json();

mutation fulfillmentOrderReleaseHold($id: ID!) {
  fulfillmentOrderReleaseHold(id: $id) {
    fulfillmentOrder {
      id
      status
      requestStatus
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation fulfillmentOrderReleaseHold($id: ID!) { fulfillmentOrderReleaseHold(id: $id) { fulfillmentOrder { id status requestStatus } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/FulfillmentOrder/564786110"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation fulfillmentOrderReleaseHold($id: ID!) {
    fulfillmentOrderReleaseHold(id: $id) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/FulfillmentOrder/564786110"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation fulfillmentOrderReleaseHold($id: ID!) {
      fulfillmentOrderReleaseHold(id: $id) {
        fulfillmentOrder {
          id
          status
          requestStatus
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/FulfillmentOrder/564786110"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation fulfillmentOrderReleaseHold($id: ID!) {
    fulfillmentOrderReleaseHold(id: $id) {
      fulfillmentOrder {
        id
        status
        requestStatus
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/FulfillmentOrder/564786110"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/FulfillmentOrder/564786110"

}

Response

JSON

{

"fulfillmentOrderReleaseHold": {

"fulfillmentOrder": {

"id": "gid://shopify/FulfillmentOrder/564786110",

"status": "OPEN",

"requestStatus": "UNSUBMITTED"

"userErrors": []

}