v55

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-012046146.0 KB

Update categories

Update existing product categories with new values. When the update is processed, the merge strategy is used to apply changes to scalar and object type fields. The replace strategy is used to apply changes for fields in an array.

Note: Update operations do not verify that the entity exists. Requests targeting a nonexistent entity are accepted, but the update has no effect.

patch/v1/catalog/categories

Headers

Authorizationstring required

Authorization Bearer token

Content-Type'application/json' required

Content-Encoding'gzip'

Use this header if the payload is compressed with gzip.

Request body

slugstring required

Category slug using hierarchical format with forward slashes to represent parent-child relationships. String can contain only lowercase letters, numbers, and hyphens. Examples: 'men', 'men/clothing', 'men/clothing/pants'

namestring

Display name of the category

descriptionstring nullable

Full-text description of the category.

familiesstring[] nullable

Optional array of product family identifiers that this category is associated with. Used for enhanced product organization and filtering. For example, for a clothing category, you can associate it with the "apparel" family. Note: This field uses the replace strategy to replace the entire array with the new values.

positioninteger

Sort order for the category

Example request

[
  {
    "slug": "men/clothing/pants",
    "source": {
      "locale": "English"
    },
    "name": "Men's Pants",
    "description": "Men's clothing, shoes, and accessories",
    "families": [
      "apparel",
      "clothing"
    ]
  }
]

Response

All items accepted and will be processed asynchronously