catalog.category.archive
Archive a category (products keep their assignment; hidden from active lists).
- scope:
catalog:write - storefront-visible (bumps the catalog generation): no
- destructive: yes — supports dryRun preview
Payload
| field | type | required | notes |
|---|---|---|---|
id | string (/^cat_[a-zA-Z0-9]{1,32}$/) | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^cat_[a-zA-Z0-9]{1,32}$"
}
},
"required": [
"id"
],
"additionalProperties": false
}Generated from the live platform registries at build time — reference pages cannot go stale. Markdown variant: /reference/commands/catalog.category.archive.md