Bulk Archive Warehouses

PUT 
/api/warehouses/archive

Archives multiple warehouses. Provide either ids (array of warehouse IDs) or apply_to_all=true with an optional filters object to target all warehouses matching the current listing filters.

Required scope: warehouses:write

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

Warehouses that cannot be archived (integration-managed, or holding stock) are skipped and counted in failCount, with a per-record warning in the response.

Authentication: Requires Bearer token.

Request

Responses

200

OK

Response Headers

Content-Type

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.