Pređi na sadržaj
ShopentlyLearn
Srpski (latinica)

Šeme podataka: Zajednički modeli

Šeme podataka: Zajednički modeli. Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.

Šeme podataka

Strukturirani podaci o grešci

ApiError · Šema · Šeme podataka: Zajednički modeli
codeNiz znakovaObavezno

Stabilan mašinski čitljiv kod.

Ograničenja
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"]
Primer: "authentication.invalid_credentials"
fieldsNiz vrednosti <FieldError > nullOpciono

Greške provere pojedinih polja.

Primer: null
messageNiz znakovaObavezno

Objašnjenje za korisnika; za programsku logiku koristite kod greške.

Primer: "The credentials are invalid."

Dodatna polja: Ne

Kreiraj — Marke — Odgovor

ApiResponse_MutationData_ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataMutationData Obavezno

Primer odgovora · MutationData.

Primer: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno

Metapodaci odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

Metapodaci odgovora

ContextMeta · Šema · Šeme podataka: Zajednički modeli
localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

Primer: "en"
market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

Primer: "PL"
market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

Primer: "example"
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer: "example"

Dodatna polja: Ne

Metapodaci odgovora

ContextPageMeta · Šema · Šeme podataka: Zajednički modeli
localeNiz znakovaObavezno

Jezik odabran za ovaj zahtev.

Primer: "en"
market_codeNiz znakovaObavezno

Kod tržišta vraćen s krajnje tačke konteksta.

Primer: "PL"
market_idNiz znakovaObavezno

Identifikator tržišta vraćen s krajnje tačke konteksta.

Primer: "example"
paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

Primer: {"has_more":false,"limit":20,"next_cursor":null}
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer: "example"

Dodatna polja: Ne

Katalog grešaka

ErrorResponse · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
errorApiError Obavezno

Strukturirani podaci o grešci.

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

Metapodaci odgovora.

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

Dodatna polja: Ne

Greške provere pojedinih polja

FieldError · Šema · Šeme podataka: Zajednički modeli
codeNiz znakovaObavezno

Stabilan mašinski čitljiv kod.

Ograničenja
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldNiz znakovaObavezno

Polje povezano s greškom provere valjanosti.

minLength: 1maxLength: 128
locationNiz znakovaObavezno

Podaci o lokaciji.

Ograničenja
enum
["path", "query", "header", "body"]

Dodatna polja: Ne

Iznos pre dodatnih sastavnica prikazanih u odgovoru

MoneyData · Šema · Šeme podataka: Zajednički modeli
amountNiz znakovaObavezno

Decimalni iznos kodiran kao JSON niz znakova; null samo gde je dozvoljen.

Primer: "0.00"
currencyNiz znakovaObavezno

Kod valute iznosa.

Ograničenja
pattern
"^[A-Z]{3}$"
Primer: "PLN"
minor_unitsCeli brojObavezno

Broj decimalnih cifara valute.

minimum: 0maximum: 4
Primer: 2

Dodatna polja: Ne

Kreiraj — Marke — Odgovor

MutationData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
deletedLogička vrednostObavezno

Da li je brisanje primenjeno.

Primer: false
idNiz znakovaObavezno

Identifikator resursa; sačuvajte ga u vraćenom obliku. (MutationData).

Primer: "example"
versionCeli broj nullObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

Metapodaci odgovora

PageMeta · Šema · Šeme podataka: Zajednički modeli
paginationPagination Obavezno

Metapodaci paginacije pomoću kursora.

Primer: {"has_more":false,"limit":20,"next_cursor":null}
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer: "example"

Dodatna polja: Ne

Metapodaci paginacije pomoću kursora

Pagination · Šema · Šeme podataka: Zajednički modeli
has_moreLogička vrednostObavezno

Da li postoji sledeća stranica.

Primer: false
limitCeli brojObavezno

Najveći broj zapisa na ovoj stranici.

minimum: 1maximum: 100
Primer: 20
next_cursorNiz znakova nullObavezno

Vrednost za nastavak na sledeću stranicu ili null.

Primer: null

Dodatna polja: Ne

Metapodaci odgovora

RequestMeta · Šema · Šeme podataka: Zajednički modeli
request_idNiz znakovaObavezno

Identifikator zahteva; u metapodacima odgovora označava HTTP zahtev.

minLength: 1maxLength: 100
Primer: "example"

Dodatna polja: Ne