Category models

Category models for lists, details, creation and updates. Inspect hierarchy, translations and the fields accepted by category mutations.

Data schemas

Get a category — Response

ApiResponse_CategoryDetailData_ · Fields, types and constraints of data accepted or returned by the API.

dataCategoryDetailData Required: Response example · CategoryDetailData.

Example: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Additional fields: No

List categories — Response

ApiResponse_list_CategorySummaryData__ · Fields, types and constraints of data accepted or returned by the API.

dataArray <CategorySummaryData > Required: Response example · ApiResponse_list_CategorySummaryData__.

Example: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Required: Response metadata.

Example: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Additional fields: No

Create a category — Request body

CategoryCreate · Fields, types and constraints of data accepted or returned by the API.

descriptionString nullOptional: Description in the selected language.

String:maxLength: 50000
introductionString nullOptional: Introductory text in the selected language.

String:maxLength: 5000
is_visibleBooleanOptional: Whether the resource is visible.

Default: false
market_idsArray <String> Optional: Identifiers of selected markets.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionString nullOptional: Search-engine description in the selected language.

String:maxLength: 160
meta_keywordsArray <String> nullOptional: Search-engine keywords in the selected language.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleString nullOptional: Search-engine title in the selected language.

String:maxLength: 70
nameStringRequired: Resource name in the relevant context.

minLength: 1maxLength: 200

Example: "Example"
parent_idString nullOptional: Parent category identifier.

String:minLength: 1maxLength: 63
slugString nullOptional: URL path segment in the selected language.

String:maxLength: 160

Additional fields: No

Get a category — Response

CategoryDetailData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired: Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
descriptionString nullRequired: Description in the selected language.

Example: "example"
idStringRequired: Resource identifier; preserve it as returned. (CategoryDetailData).

Example: "example"
introductionString nullRequired: Introductory text in the selected language.

Example: "example"
is_availableBooleanRequired: Whether the item is available in this context.

Example: true
is_visibleBooleanRequired: Whether the resource is visible.

Example: false
meta_descriptionString nullRequired: Search-engine description in the selected language.

Example: "example"
meta_keywordsArray <String> nullRequired: Search-engine keywords in the selected language.

Example: ["example"]
meta_titleString nullRequired: Search-engine title in the selected language.

Example: "example"
nameString nullRequired: Resource name in the relevant context.

Example: "Example"
numberStringRequired: Human-facing order or request number.

Example: "example"
parent_idString nullRequired: Parent category identifier.

Example: null
slugString nullRequired: URL path segment in the selected language.

Example: "example"
updated_atStringRequired: Most recent update time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
versionIntegerRequired: Resource version used for concurrency control.

Example: 1

Additional fields: No

List categories — Response

CategorySummaryData · Fields, types and constraints of data accepted or returned by the API.

created_atStringRequired: Creation time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
idStringRequired: Resource identifier; preserve it as returned. (CategorySummaryData).

Example: "example"
is_availableBooleanRequired: Whether the item is available in this context.

Example: true
is_visibleBooleanRequired: Whether the resource is visible.

Example: false
nameString nullRequired: Resource name in the relevant context.

Example: "Example"
numberStringRequired: Human-facing order or request number.

Example: "example"
parent_idString nullRequired: Parent category identifier.

Example: null
slugString nullRequired: URL path segment in the selected language.

Example: "example"
updated_atStringRequired: Most recent update time.

format: "date-time"

Example: "2026-01-01T12:00:00Z"
versionIntegerRequired: Resource version used for concurrency control.

Example: 1

Additional fields: No

Update a category — Request body

CategoryUpdate · Fields, types and constraints of data accepted or returned by the API.

descriptionString nullOptional: Description in the selected language.

String:maxLength: 50000
expected_versionIntegerRequired: Version read before the write; a mismatch rejects the update.

minimum: 1maximum: 9223372036854775807

Example: 1
introductionString nullOptional: Introductory text in the selected language.

String:maxLength: 5000
is_visibleBooleanOptional: Whether the resource is visible.
market_idsArray <String> Optional: Identifiers of selected markets.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionString nullOptional: Search-engine description in the selected language.

String:maxLength: 160
meta_keywordsArray <String> nullOptional: Search-engine keywords in the selected language.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleString nullOptional: Search-engine title in the selected language.

String:maxLength: 70
nameString nullOptional: Resource name in the relevant context.

String:maxLength: 200

Example: "Example"
parent_idString nullOptional: Parent category identifier.

String:minLength: 1maxLength: 63
slugString nullOptional: URL path segment in the selected language.

String:maxLength: 160

Additional fields: No