Esquemas de datos: Modelos compartidos

codeCadena de textoObligatorio

Código estable legible por programas.

Restricciones

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

Ejemplo: "authentication.invalid_credentials"

fieldsLista <FieldError > | nullOpcional

Errores de validación de campos individuales.

Ejemplo: null

messageCadena de textoObligatorio

Explicación para personas; utiliza el código de error en la lógica del programa.

Ejemplo: "The credentials are invalid."

Campos adicionales: No

dataMutationData Obligatorio

Ejemplo de respuesta · MutationData.

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

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

localeCadena de textoObligatorio

Idioma seleccionado para esta solicitud.

Ejemplo: "en"

market_codeCadena de textoObligatorio

Código del mercado devuelto por el endpoint de contexto.

Ejemplo: "PL"

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

Ejemplo: "example"

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

Ejemplo: "example"

Campos adicionales: No

localeCadena de textoObligatorio

Idioma seleccionado para esta solicitud.

Ejemplo: "en"

market_codeCadena de textoObligatorio

Código del mercado devuelto por el endpoint de contexto.

Ejemplo: "PL"

market_idCadena de textoObligatorio

Identificador del mercado devuelto por el endpoint de contexto.

Ejemplo: "example"

paginationPagination Obligatorio

Metadatos de la paginación por cursor.

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

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

Ejemplo: "example"

Campos adicionales: No

errorApiError Obligatorio

Información estructurada del error.

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

metaRequestMeta Obligatorio

Metadatos de la respuesta.

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

Campos adicionales: No

codeCadena de textoObligatorio

Código estable legible por programas.

Restricciones

enum

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

fieldCadena de textoObligatorio

Campo asociado a un error de validación.

minLength: 1maxLength: 128

locationCadena de textoObligatorio

Información de la ubicación.

Restricciones

enum

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

Campos adicionales: No

amountCadena de textoObligatorio

Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: "0.00"

currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones

pattern

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

Ejemplo: "PLN"

minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4

Ejemplo: 2

Campos adicionales: No

deletedBooleanoObligatorio

Indica si se aplicó la eliminación.

Ejemplo: false

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (MutationData).

Ejemplo: "example"

versionNúmero entero | nullObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

paginationPagination Obligatorio

Metadatos de la paginación por cursor.

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

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

Ejemplo: "example"

Campos adicionales: No

has_moreBooleanoObligatorio

Indica si hay otra página disponible.

Ejemplo: false

limitNúmero enteroObligatorio

Número máximo de registros en esta página.

minimum: 1maximum: 100

Ejemplo: 20

next_cursorCadena de texto | nullObligatorio

Valor de continuación para la página siguiente, o null.

Ejemplo: null

Campos adicionales: No

request_idCadena de textoObligatorio

Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

Ejemplo: "example"

Campos adicionales: No