Archive BOM

POST 
/api/manufacturing/boms/:id/archive

Archives an Active BOM, marking it as retired (sets archived_at). If the archived BOM was the default for its product/variant, the next eligible BOM is auto-promoted to default. Returns the refreshed BOM object under data (200), plus a root-level promoted_default object ({id, name, version_number}) naming the newly-promoted default — or null if nothing was promoted. The frontend uses this to show "BOM archived — {name} v{version} is now the default". The optional reason (nullable string, max 1000) is recorded on the BOM activity log.

Required scope: manufacturing:write

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

Request

Responses

200

Successful response

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.