Skip to content

Category

Type: schema

TypeScript Definition

typescript
Category: {{
            readonly id: string;
            readonly name: string;
            readonly slug: string;
            description: string | null;
            readonly parent_category_id: string | null;
            product_count: number;
            active: boolean;
        };
        /** CollectInStore */
}

OpenAPI Schema

json
{
  "title": "Category",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Category",
    "description": "API reference for the Category schema"
  },
  "required": [
    "id",
    "name",
    "slug",
    "description",
    "parent_category_id",
    "product_count",
    "active"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "readOnly": true
    },
    "slug": {
      "type": "string",
      "readOnly": true
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "parent_category_id": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "product_count": {
      "type": "integer"
    },
    "active": {
      "type": "boolean"
    }
  },
  "examples": []
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: