Skip to content
ShopentlyLearn
English

Shared API models

Shared Shopently API models for pagination, money and errors. Inspect common field types and constraints reused across resources.

Data schemas

Structured error information

ApiError · Schema · Shared API models
codeStringRequired

Stable machine-readable code.

Constraints
enum
["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]
Example: "authentication.invalid_credentials"
fieldsArray <FieldError > nullOptional

Individual field validation errors.

Example: null
messageStringRequired

Human-readable explanation; use the error code for program logic.

Example: "The credentials are invalid."

Additional fields: No

Create a brand — Response

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

Response example · MutationData.

Example: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Required

Response metadata.

Example: {"request_id":"example"}

Additional fields: No

Response metadata

ContextMeta · Schema · Shared API models
localeStringRequired

Language selected for this request.

Example: "en"
market_codeStringRequired

Market code returned by the context endpoint.

Example: "PL"
market_idStringRequired

Market identifier returned by the context endpoint.

Example: "example"
request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Example: "example"

Additional fields: No

Response metadata

ContextPageMeta · Schema · Shared API models
localeStringRequired

Language selected for this request.

Example: "en"
market_codeStringRequired

Market code returned by the context endpoint.

Example: "PL"
market_idStringRequired

Market identifier returned by the context endpoint.

Example: "example"
paginationPagination Required

Cursor pagination metadata.

Example: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Example: "example"

Additional fields: No

Error catalog

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

Structured error information.

Example: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}
metaRequestMeta Required

Response metadata.

Example: {"request_id":"example-request"}

Additional fields: No

Individual field validation errors

FieldError · Schema · Shared API models
codeStringRequired

Stable machine-readable code.

Constraints
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldStringRequired

Field associated with a validation error.

minLength: 1maxLength: 128
locationStringRequired

Location information.

Constraints
enum
["path", "query", "header", "body"]

Additional fields: No

Amount before the additional components shown in the response

MoneyData · Schema · Shared API models
amountStringRequired

Decimal amount encoded as a JSON string; null only where allowed.

Example: "0.00"
currencyStringRequired

Currency code for the amount.

Constraints
pattern
"^[A-Z]{3}$"
Example: "PLN"
minor_unitsIntegerRequired

Number of fractional digits used by the currency.

minimum: 0maximum: 4
Example: 2

Additional fields: No

Create a brand — Response

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

Whether the deletion was applied.

Example: false
idStringRequired

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

Example: "example"
versionInteger nullRequired

Resource version used for concurrency control.

Example: 1

Additional fields: No

Response metadata

PageMeta · Schema · Shared API models
paginationPagination Required

Cursor pagination metadata.

Example: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Example: "example"

Additional fields: No

Cursor pagination metadata

Pagination · Schema · Shared API models
has_moreBooleanRequired

Whether another page is available.

Example: false
limitIntegerRequired

Maximum number of records on this page.

minimum: 1maximum: 100
Example: 20
next_cursorString nullRequired

Continuation value for the next page, or null.

Example: null

Additional fields: No

Response metadata

RequestMeta · Schema · Shared API models
request_idStringRequired

Request identifier; in response metadata this identifies the HTTP request.

minLength: 1maxLength: 100
Example: "example"

Additional fields: No