Skip to content
ShopentlyLearn

Feature and value models

Models for features and feature values. Check the field types, translated values and payloads used to create or update product attributes.

Data schemas

Get a feature — Response

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

Response example · FeatureData.

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

Get a feature value — Response

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

Response example · FeatureValueData.

Example: {"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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 features — Response

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

Response example · ApiResponse_list_FeatureData__.

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

List feature values — Response

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

Response example · ApiResponse_list_FeatureValueData__.

Example: [{"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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 feature — Request body

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

Resource name in the relevant context.

minLength: 1maxLength: 120
Constraints
pattern
"^[^\\x00]*$"
Example: "Example"
positionIntegerOptional

Position in the ordered collection.

minimum: 0maximum: 2147483647

Additional fields: No

Get a feature — Response

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

Example: "example"
nameString nullRequired

Resource name in the relevant context.

Example: "Example"
numberStringRequired

Human-facing order or request number.

Example: "example"
positionIntegerRequired

Position in the ordered collection.

Example: 1
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

Product features

FeatureSelectionData · Schema · Feature and value models
feature_idStringRequired

Feature identifier.

Example: "example"
feature_nameString nullRequired

Feature name.

Example: "example"
valueString nullRequired

Value described by the surrounding schema.

Example: "example"
value_idStringRequired

Dictionary value identifier.

Example: "example"

Additional fields: No

Update a feature — Request body

FeatureUpdate · 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
nameString nullOptional

Resource name in the relevant context.

String:minLength: 1maxLength: 120
Constraints · String 1
pattern
"^[^\\x00]*$"
Example: "Example"
positionIntegerOptional

Position in the ordered collection.

minimum: 0maximum: 2147483647

Additional fields: No

Create a feature value — Request body

FeatureValueCreate · 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
positionIntegerOptional

Position in the ordered collection.

minimum: 0maximum: 2147483647
valueStringRequired

Value described by the surrounding schema.

minLength: 1maxLength: 180
Constraints
pattern
"^[^\\x00]*$"
Example: "Example"

Additional fields: No

Get a feature value — Response

FeatureValueData · 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"
feature_idStringRequired

Feature identifier.

Example: "example"
idStringRequired

Resource identifier; preserve it as returned. (FeatureValueData).

Example: "example"
numberStringRequired

Human-facing order or request number.

Example: "example"
positionIntegerRequired

Position in the ordered collection.

Example: 1
updated_atStringRequired

Most recent update time.

format: "date-time"
Example: "2026-01-01T12:00:00Z"
valueString nullRequired

Value described by the surrounding schema.

Example: "example"
versionIntegerRequired

Resource version used for concurrency control.

Example: 1

Additional fields: No

Update a feature value — Request body

FeatureValueUpdate · 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
positionIntegerOptional

Position in the ordered collection.

minimum: 0maximum: 2147483647
valueString nullOptional

Value described by the surrounding schema.

String:minLength: 1maxLength: 180
Constraints · String 1
pattern
"^[^\\x00]*$"
Example: "Example"

Additional fields: No