Esquemas de dados: Modelos compartilhados

codeTextoObrigatório

Código estável legível por programas.

Restrições

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

Exemplo: "authentication.invalid_credentials"

fieldsLista <FieldError > | nullOpcional

Erros de validação de campos individuais.

Exemplo: null

messageTextoObrigatório

Explicação para pessoas; use o código de erro na lógica do programa.

Exemplo: "The credentials are invalid."

Campos adicionais: Não

dataMutationData Obrigatório

Exemplo de resposta · MutationData.

Exemplo: {"deleted":false,"id":"example","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obrigatório

Metadados da resposta.

Exemplo: {"request_id":"example"}

Campos adicionais: Não

localeTextoObrigatório

Idioma selecionado para esta requisição.

Exemplo: "en"

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

Exemplo: "PL"

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

Exemplo: "example"

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

Exemplo: "example"

Campos adicionais: Não

localeTextoObrigatório

Idioma selecionado para esta requisição.

Exemplo: "en"

market_codeTextoObrigatório

Código do mercado retornado pelo endpoint de contexto.

Exemplo: "PL"

market_idTextoObrigatório

Identificador do mercado retornado pelo endpoint de contexto.

Exemplo: "example"

paginationPagination Obrigatório

Metadados da paginação por cursor.

Exemplo: {"has_more":false,"limit":20,"next_cursor":null}

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

Exemplo: "example"

Campos adicionais: Não

errorApiError Obrigatório

Informações estruturadas do erro.

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

metaRequestMeta Obrigatório

Metadados da resposta.

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

Campos adicionais: Não

codeTextoObrigatório

Código estável legível por programas.

Restrições

enum

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

fieldTextoObrigatório

Campo associado a um erro de validação.

minLength: 1maxLength: 128

locationTextoObrigatório

Informações da localização.

Restrições

enum

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

Campos adicionais: Não

amountTextoObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

Exemplo: "0.00"

currencyTextoObrigatório

Código da moeda do valor.

Restrições

pattern

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

Exemplo: "PLN"

minor_unitsNúmero inteiroObrigatório

Número de casas decimais utilizadas pela moeda.

minimum: 0maximum: 4

Exemplo: 2

Campos adicionais: Não

deletedBooleanoObrigatório

Indica se a exclusão foi aplicada.

Exemplo: false

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (MutationData).

Exemplo: "example"

versionNúmero inteiro | nullObrigatório

Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

paginationPagination Obrigatório

Metadados da paginação por cursor.

Exemplo: {"has_more":false,"limit":20,"next_cursor":null}

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

Exemplo: "example"

Campos adicionais: Não

has_moreBooleanoObrigatório

Indica se há outra página disponível.

Exemplo: false

limitNúmero inteiroObrigatório

Número máximo de registros nesta página.

minimum: 1maximum: 100

Exemplo: 20

next_cursorTexto | nullObrigatório

Valor de continuação da próxima página, ou null.

Exemplo: null

Campos adicionais: Não

request_idTextoObrigatório

Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

Exemplo: "example"

Campos adicionais: Não