catalog.category.update

Update a category's name, installment cap, or position.

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

Payload

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}$"
    },
    "patch": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 80
        },
        "taksitCap": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 12
            },
            {
              "type": "null"
            }
          ]
        },
        "position": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "patch"
  ],
  "additionalProperties": false
}