Bulk Create Inventory Holds

POST 
/api/v2/inventory/holds/bulk

Creates inventory holds for multiple products in the same warehouse in a single request. Up to 100 items per request.

Required scope: inventory:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Request Body:

• warehouse_id (required, integer): Warehouse where all items are held
• reason (required, string, max 255): Reason applied to all holds
• notes (optional, string): Notes applied to all holds
• expires_at (optional, date, must be future): Expiration applied to all holds
• items (required, array, 1-100): Array of items to hold
  • items.*.product_id (required, integer): Product ID
  • items.*.quantity (required, numeric, min 0.0001): Quantity to hold

Requires permission: inventory.adjust

notes is required when reason is other; optional otherwise.

Request

Responses

201

Created

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.