CategoryCommonDetail
Type: schema
TypeScript Definition
typescript
CategoryCommonDetail: {{
id?: $Read<string>;
name?: string;
description?: string | null;
/** @default true */
active: boolean;
parent_category_id?: string | null;
slug?: string;
product_count?: $Read<number>;
/** Format: date-time */
created_at?: $Read<string>;
/** Format: date-time */
modified_at?: $Read<string>;
auto_assign_products?: $Read<boolean>;
/** @description Filter that selects products auto-assigned to the category when `auto_assign_products` is `true`. Read-only. */
assign_products_condition?: components["schemas"]["DataFilterObject"] | null;
/** @description Depth in the category tree. `1` for a root category. */
nested_level?: $Read<number>;
/** @description Direct children, each nesting its own `child_categories`. */
child_categories?: components["schemas"]["ChildCategory"][];
};
/**
* Channel
* @description A store's sales channel: a storefront (web, app or point of sale) or a marketplace the store sells on. Credentials are masked; a marketplace channel's seller account comes in the `seller.account.*` events.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["DataFilterObject"] | DataFilterObject |
components["schemas"]["ChildCategory"] | ChildCategory |
OpenAPI Schema
json
{
"title": "CategoryCommonDetail",
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"active": {
"type": "boolean",
"default": true
},
"parent_category_id": {
"type": [
"string",
"null"
]
},
"slug": {
"type": "string"
},
"product_count": {
"type": "integer",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"auto_assign_products": {
"type": "boolean",
"readOnly": true
},
"assign_products_condition": {
"description": "Filter that selects products auto-assigned to the category when `auto_assign_products` is `true`. Read-only.",
"anyOf": [
{
"$ref": "#/components/schemas/DataFilterObject"
},
{
"type": "null"
}
]
},
"nested_level": {
"description": "Depth in the category tree. `1` for a root category.",
"type": "integer",
"readOnly": true
},
"child_categories": {
"description": "Direct children, each nesting its own `child_categories`.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ChildCategory"
}
}
},
"x-tags": [
"Catalog"
]
}Auto-generated from OpenAPI spec and TypeScript definitions