Bulk Place Shipments On Hold | ShipBob Developer API

Places a Manual hold on multiple shipments in a single request. By default the committed inventory stays reserved and an allocation hold is placed; set reserve_inventory to false to deallocate the committed inventory instead (mirrors the dashboard’s “Unreserve” option).

Per-shipment results: every shipment is evaluated independently and returns its own success/failure in results; one shipment failing never fails the whole request. A shipment already on a Manual hold is an idempotent success. Shipments that are picked, being fulfilled, cancelled, shipped, or otherwise ineligible fail individually. HTTP 400 is only returned when the request itself is malformed (empty shipment_ids or over the batch cap).

Places a Manual hold on multiple shipments in a single request. By default the committed inventory stays reserved and an allocation hold is placed; set `reserve_inventory` to `false` to deallocate the committed inventory instead (mirrors the dashboard's "Unreserve" option). **Per-shipment results:** every shipment is evaluated independently and returns its own success/failure in `results`; one shipment failing never fails the whole request. A shipment already on a Manual hold is an idempotent success. Shipments that are picked, being fulfilled, cancelled, shipped, or otherwise ineligible fail individually. HTTP 400 is only returned when the request itself is malformed (empty `shipment_ids` or over the batch cap).

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Request

This endpoint expects an object.

shipment_idslist of longsRequired

Shipments to place on hold. Must contain at least one id.

reserve_inventorybooleanOptionalDefaults to true

When true (default), inventory stays committed and an allocation hold is placed. When false, the committed inventory is deallocated (the dashboard’s ‘Unreserve’ option).

Response

summaryobject

Summary of the bulk operation results

resultslist of objects or nullOptional

Per-shipment results of the bulk operation

Errors

400

Bad Request Error