fulfillmentOrdersReleaseHolds

mutationDeprecated

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 holds on a list of fulfillment orders. This mutation is deprecated and will be removed in the 2024-10 API version. Consider using the fulfillmentOrderReleaseHold mutation instead.

Arguments

Anchor to externalIdexternalId • String: A configurable ID used to track the automation system releasing these holds.
Anchor to idsids • [ID!]!required: The IDs of the fulfillment orders for which to release the fulfillment holds.

Was this section helpful?

Anchor to FulfillmentOrdersReleaseHoldsPayload returnsFulfillmentOrdersReleaseHoldsPayload returns

Anchor to jobjob • Job: The asynchronous job that will release the fulfillment holds.
Anchor to userErrorsuserErrors • [FulfillmentOrdersReleaseHoldsUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation fulfillmentOrdersReleaseHolds($externalId: String, $ids: [ID!]!) {
2  fulfillmentOrdersReleaseHolds(externalId: $externalId, ids: $ids) {
3    job {
4      # Job fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "externalId": "<your-externalId>",
3  "ids": [
4    "gid://shopify/<objectName>/10079785100"
5  ]
6}

{
  "externalId": "<your-externalId>",
  "ids": [
    "gid://shopify/<objectName>/10079785100"
  ]
}