CategoryCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/emporix/main/json-schema/emporix-category-create-request-schema.json",
  "title": "CategoryCreateRequest",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/emporix-category-tree-openapi.yml#/components/schemas/CategoryCreateRequest",
  "required": [
    "localizedName",
    "published"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Custom category identifier. If not provided, it is automatically generated"
    },
    "type": {
      "type": "string",
      "enum": [
        "CLASSIFICATION",
        "STANDARD"
      ],
      "description": "Category type, by default it is `STANDARD`."
    },
    "localizedName": {
      "minItems": 1,
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Localized category name in a form of a map of translations."
    },
    "localizedDescription": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Localized category description in a form of a map of translations."
    },
    "parentId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Unique identifier of the parent category. No parentId in the body indicates that this is a root category."
    },
    "localizedSlug": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Provides localized category name or code without diacritics for the URL."
    },
    "ecn": {
      "type": [
        "array",
        "null"
      ],
      "description": "List of external category numbers (ECNs) unique for every category.",
      "items": {
        "type": "string"
      }
    },
    "code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Unique category identifier, defined by the tenant. Required for category of type `CLASSIFICATION`."
    },
    "validity": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "format": "date-time"
      },
      "description": "Category validity."
    },
    "position": {
      "minimum": 0,
      "type": [
        "integer",
        "null"
      ],
      "description": "Category position, set in relation to the categories on the same level (sharing the same parent) in the tree.",
      "format": "int32"
    },
    "published": {
      "type": "boolean",
      "description": "Flag indicating whether the category has been published or not."
    },
    "ownClassificationMixins": {
      "type": "array",
      "description": "List of classification mixins defined by this category.",
      "items": {
        "$ref": "#/$defs/OwnClassificationMixin"
      }
    },
    "mixins": {
      "type": "object",
      "additionalProperties": true,
      "description": "Custom category attributes that need to be included directly in the mixins object."
    },
    "metadata": {
      "$ref": "#/$defs/MetadataCreate"
    }
  },
  "$defs": {
    "MetadataCreate": {
      "type": "object",
      "properties": {
        "mixins": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "A key-value map, where key is a mixin name and value is a link to the mixin schema."
        }
      }
    },
    "OwnClassificationMixin": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the mixin.",
          "pattern": "^[a-zA-Z0-9_]\\S*$"
        },
        "schemaUrl": {
          "type": "string",
          "description": "URL of the mixin schema.",
          "pattern": "^https?://[^\\s/$.?#].\\S*$"
        },
        "required": {
          "type": "boolean",
          "description": "Indicates whether the mixin is required."
        }
      },
      "required": [
        "name",
        "schemaUrl"
      ],
      "description": "Classification mixin defined for a given category."
    }
  }
}