Ga naar de inhoud
ShopentlyLearn
Nederlands

Gegevensschema’s: Gedeelde modellen

Gegevensschema’s: Gedeelde modellen. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Gestructureerde foutinformatie

ApiError · Schema · Gegevensschema’s: Gedeelde modellen
codeTekenreeksVerplicht

Stabiele, machineleesbare code.

Beperkingen
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"]
Voorbeeld: "authentication.invalid_credentials"
fieldsArray <FieldError > nullOptioneel

Validatiefouten per veld.

Voorbeeld: null
messageTekenreeksVerplicht

Leesbare toelichting; gebruik de foutcode voor programmalogica.

Voorbeeld: "The credentials are invalid."

Aanvullende velden: Nee

Aanmaken — Merken — Antwoord

ApiResponse_MutationData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataMutationData Verplicht

Voorbeeldantwoord · MutationData.

Voorbeeld: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Verplicht

Metadata van het antwoord.

Voorbeeld: {"request_id":"example"}

Aanvullende velden: Nee

Metadata van het antwoord

ContextMeta · Schema · Gegevensschema’s: Gedeelde modellen
localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "en"
market_codeTekenreeksVerplicht

Marktcode die het contextendpoint teruggeeft.

Voorbeeld: "PL"
market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

Voorbeeld: "example"
request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeld: "example"

Aanvullende velden: Nee

Metadata van het antwoord

ContextPageMeta · Schema · Gegevensschema’s: Gedeelde modellen
localeTekenreeksVerplicht

Taal die voor dit verzoek is geselecteerd.

Voorbeeld: "en"
market_codeTekenreeksVerplicht

Marktcode die het contextendpoint teruggeeft.

Voorbeeld: "PL"
market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

Voorbeeld: "example"
paginationPagination Verplicht

Metadata voor cursorpaginering.

Voorbeeld: {"has_more":false,"limit":20,"next_cursor":null}
request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeld: "example"

Aanvullende velden: Nee

Foutencatalogus

ErrorResponse · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
errorApiError Verplicht

Gestructureerde foutinformatie.

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

Metadata van het antwoord.

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

Aanvullende velden: Nee

Validatiefouten per veld

FieldError · Schema · Gegevensschema’s: Gedeelde modellen
codeTekenreeksVerplicht

Stabiele, machineleesbare code.

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

Veld waarop een validatiefout betrekking heeft.

minLength: 1maxLength: 128
locationTekenreeksVerplicht

Locatiegegevens.

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

Aanvullende velden: Nee

Bedrag vóór de aanvullende componenten in het antwoord

MoneyData · Schema · Gegevensschema’s: Gedeelde modellen
amountTekenreeksVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Voorbeeld: "0.00"
currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen
pattern
"^[A-Z]{3}$"
Voorbeeld: "PLN"
minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4
Voorbeeld: 2

Aanvullende velden: Nee

Aanmaken — Merken — Antwoord

MutationData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
deletedBooleaanse waardeVerplicht

Of de verwijdering is uitgevoerd.

Voorbeeld: false
idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (MutationData).

Voorbeeld: "example"
versionGeheel getal nullVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Metadata van het antwoord

PageMeta · Schema · Gegevensschema’s: Gedeelde modellen
paginationPagination Verplicht

Metadata voor cursorpaginering.

Voorbeeld: {"has_more":false,"limit":20,"next_cursor":null}
request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeld: "example"

Aanvullende velden: Nee

Metadata voor cursorpaginering

Pagination · Schema · Gegevensschema’s: Gedeelde modellen
has_moreBooleaanse waardeVerplicht

Of er nog een pagina beschikbaar is.

Voorbeeld: false
limitGeheel getalVerplicht

Maximaal aantal records op deze pagina.

minimum: 1maximum: 100
Voorbeeld: 20
next_cursorTekenreeks nullVerplicht

Vervolgwaarde voor de volgende pagina, of null.

Voorbeeld: null

Aanvullende velden: Nee

Metadata van het antwoord

RequestMeta · Schema · Gegevensschema’s: Gedeelde modellen
request_idTekenreeksVerplicht

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeld: "example"

Aanvullende velden: Nee