Vai al contenuto
ShopentlyLearn
Italiano

Schemi dei dati: Modelli condivisi

Schemi dei dati: Modelli condivisi. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Informazioni strutturate sull’errore

ApiError · Schema · Schemi dei dati: Modelli condivisi
codeStringaObbligatorio

Codice stabile interpretabile dal software.

Vincoli
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"]
Esempio: "authentication.invalid_credentials"
fieldsArray <FieldError > nullFacoltativo

Errori di validazione dei singoli campi.

Esempio: null
messageStringaObbligatorio

Spiegazione leggibile; per la logica del programma usa il codice dell’errore.

Esempio: "The credentials are invalid."

Campi aggiuntivi: No

Crea — Marchi — Risposta

ApiResponse_MutationData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataMutationData Obbligatorio

Esempio di risposta · MutationData.

Esempio: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example"}

Campi aggiuntivi: No

Metadati della risposta

ContextMeta · Schema · Schemi dei dati: Modelli condivisi
localeStringaObbligatorio

Lingua selezionata per questa richiesta.

Esempio: "en"
market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

Esempio: "PL"
market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

Esempio: "example"
request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio: "example"

Campi aggiuntivi: No

Metadati della risposta

ContextPageMeta · Schema · Schemi dei dati: Modelli condivisi
localeStringaObbligatorio

Lingua selezionata per questa richiesta.

Esempio: "en"
market_codeStringaObbligatorio

Codice del mercato restituito dall’endpoint del contesto.

Esempio: "PL"
market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

Esempio: "example"
paginationPagination Obbligatorio

Metadati della paginazione a cursore.

Esempio: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio: "example"

Campi aggiuntivi: No

Catalogo degli errori

ErrorResponse · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
errorApiError Obbligatorio

Informazioni strutturate sull’errore.

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

Metadati della risposta.

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

Campi aggiuntivi: No

Errori di validazione dei singoli campi

FieldError · Schema · Schemi dei dati: Modelli condivisi
codeStringaObbligatorio

Codice stabile interpretabile dal software.

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

Campo associato a un errore di validazione.

minLength: 1maxLength: 128
locationStringaObbligatorio

Informazioni sull’ubicazione.

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

Campi aggiuntivi: No

Importo prima delle componenti aggiuntive indicate nella risposta

MoneyData · Schema · Schemi dei dati: Modelli condivisi
amountStringaObbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

Esempio: "0.00"
currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli
pattern
"^[A-Z]{3}$"
Esempio: "PLN"
minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4
Esempio: 2

Campi aggiuntivi: No

Crea — Marchi — Risposta

MutationData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
deletedBooleanoObbligatorio

Indica se l’eliminazione è stata applicata.

Esempio: false
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (MutationData).

Esempio: "example"
versionIntero nullObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Metadati della risposta

PageMeta · Schema · Schemi dei dati: Modelli condivisi
paginationPagination Obbligatorio

Metadati della paginazione a cursore.

Esempio: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio: "example"

Campi aggiuntivi: No

Metadati della paginazione a cursore

Pagination · Schema · Schemi dei dati: Modelli condivisi
has_moreBooleanoObbligatorio

Indica se è disponibile un’altra pagina.

Esempio: false
limitInteroObbligatorio

Numero massimo di record in questa pagina.

minimum: 1maximum: 100
Esempio: 20
next_cursorStringa nullObbligatorio

Valore di continuazione per la pagina successiva, oppure null.

Esempio: null

Campi aggiuntivi: No

Metadati della risposta

RequestMeta · Schema · Schemi dei dati: Modelli condivisi
request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio: "example"

Campi aggiuntivi: No