Схеми на данните: Общи модели

codeНизЗадължително

Устойчив машинночетим код.

Ограничения

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"]

Пример: "authentication.invalid_credentials"

fieldsМасив <FieldError > | nullНезадължително

Грешки при валидиране на отделни полета.

Пример: null

messageНизЗадължително

Обяснение за човека; използвайте кода за грешка в програмната логика.

Пример: "The credentials are invalid."

Допълнителни полета: Не

dataMutationData Задължително

Примерен отговор · MutationData.

Пример: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Задължително

Метаданни на отговора.

Пример: {"request_id":"example"}

Допълнителни полета: Не

localeНизЗадължително

Език, избран за тази заявка.

Пример: "en"

market_codeНизЗадължително

Код на пазара, върнат от endpoint за контекст.

Пример: "PL"

market_idНизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Пример: "example"

request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100

Пример: "example"

Допълнителни полета: Не

localeНизЗадължително

Език, избран за тази заявка.

Пример: "en"

market_codeНизЗадължително

Код на пазара, върнат от endpoint за контекст.

Пример: "PL"

market_idНизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Пример: "example"

paginationPagination Задължително

Метаданни за страниране с cursor.

Пример: {"has_more":false,"limit":20,"next_cursor":null}

request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100

Пример: "example"

Допълнителни полета: Не

errorApiError Задължително

Структурирана информация за грешката.

Пример: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}

metaRequestMeta Задължително

Метаданни на отговора.

Пример: {"request_id":"example-request"}

Допълнителни полета: Не

codeНизЗадължително

Устойчив машинночетим код.

Ограничения

enum

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

fieldНизЗадължително

Поле, свързано с грешка при валидиране.

minLength: 1maxLength: 128

locationНизЗадължително

Информация за местоположението.

Ограничения

enum

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

Допълнителни полета: Не

amountНизЗадължително

Десетична сума, кодирана като JSON низ; null само когато е позволено.

Пример: "0.00"

currencyНизЗадължително

Валутен код на сумата.

Ограничения

pattern

"^[A-Z]{3}$"

Пример: "PLN"

minor_unitsЦяло числоЗадължително

Брой дробни цифри, използвани от валутата.

minimum: 0maximum: 4

Пример: 2

Допълнителни полета: Не

deletedБулева стойностЗадължително

Дали изтриването е приложено.

Пример: false

idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид. (MutationData).

Пример: "example"

versionЦяло число | nullЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не

paginationPagination Задължително

Метаданни за страниране с cursor.

Пример: {"has_more":false,"limit":20,"next_cursor":null}

request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100

Пример: "example"

Допълнителни полета: Не

has_moreБулева стойностЗадължително

Дали има следваща страница.

Пример: false

limitЦяло числоЗадължително

Максимален брой записи на тази страница.

minimum: 1maximum: 100

Пример: 20

next_cursorНиз | nullЗадължително

Стойност за продължаване към следващата страница или null.

Пример: null

Допълнителни полета: Не

request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100

Пример: "example"

Допълнителни полета: Не