Archive Product Type
PUT/api/v2/product-types/:type/archive
Archive a product type so it disappears from lists, pickers and the channel category maps. A type with active child types cannot be archived — archive or move the children first. A type that still carries products needs move_to: its products and its per-channel category-map rows are merged into that leaf type first (the same rules as Merge Product Type), then the type is archived. Archiving an already archived type is a no-op.
products:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Fields:
move_to(nullable, integer) — the active leaf type that takes over this type's products. Required when the type has products; the response tells you how many.
Requires permission: product_types.archive
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.