Skip to content
ShopentlyLearn
English

Brand models

Brand models for lists, details, creation and updates. Inspect localized fields, identifiers and validation constraints.

Data schemas

Get a brand — Response

ApiResponse_BrandData_ · Fields, types and constraints of data accepted or returned by the API.
dataBrandData Required

Response example · BrandData.

Example: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"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 brands — Response

ApiResponse_list_BrandData__ · Fields, types and constraints of data accepted or returned by the API.
dataArray <BrandData > Required

Response example · ApiResponse_list_BrandData__.

Example: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"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 brand — Request body

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

Resource name in the relevant context.

minLength: 1maxLength: 160
Example: "Example"

Additional fields: No

Get a brand — Response

BrandData · 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. (BrandData).

Example: "example"
nameStringRequired

Resource name in the relevant context.

Example: "Example"
numberStringRequired

Human-facing order or request number.

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 brand — Request body

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

Version read before the write; a mismatch rejects the update.

minimum: 1maximum: 9223372036854775807
Example: 1
nameStringRequired

Resource name in the relevant context.

minLength: 1maxLength: 160
Example: "Example"

Additional fields: No