catalog.collection.setProducts

Wholesale-replace a collection's product list (order = array order = manual sort).

• scope: catalog:write
• storefront-visible (bumps the catalog generation): yes
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^col_[a-zA-Z0-9]{1,32}$"
    },
    "productIds": {
      "maxItems": 500,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^prd_[a-zA-Z0-9]{1,32}$"
      }
    }
  },
  "required": [
    "id",
    "productIds"
  ],
  "additionalProperties": false
}