Pāriet uz saturu
ShopentlyLearn
Latviešu

Datu shēmas: Kopīgie modeļi

Datu shēmas: Kopīgie modeļi. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Strukturēta kļūdas informācija

ApiError · Shēma · Datu shēmas: Kopīgie modeļi
codeVirkneObligāts

Stabils mašīnlasāms kods.

Ierobežojumi
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"]
Piemērs: "authentication.invalid_credentials"
fieldsMasīvs <FieldError > nullNeobligāts

Atsevišķu lauku validācijas kļūdas.

Piemērs: null
messageVirkneObligāts

Cilvēkam lasāms skaidrojums; programmas loģikai izmantojiet kļūdas kodu.

Piemērs: "The credentials are invalid."

Papildu lauki: Nē

Izveidot — Zīmoli — Atbilde

ApiResponse_MutationData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataMutationData Obligāts

Atbildes piemērs · MutationData.

Piemērs: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example"}

Papildu lauki: Nē

Atbildes metadati

ContextMeta · Shēma · Datu shēmas: Kopīgie modeļi
localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

Piemērs: "en"
market_codeVirkneObligāts

Konteksta galapunkta atgrieztais tirgus kods.

Piemērs: "PL"
market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Piemērs: "example"
request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Piemērs: "example"

Papildu lauki: Nē

Atbildes metadati

ContextPageMeta · Shēma · Datu shēmas: Kopīgie modeļi
localeVirkneObligāts

Šim pieprasījumam izvēlētā valoda.

Piemērs: "en"
market_codeVirkneObligāts

Konteksta galapunkta atgrieztais tirgus kods.

Piemērs: "PL"
market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Piemērs: "example"
paginationPagination Obligāts

Kursora lapošanas metadati.

Piemērs: {"has_more":false,"limit":20,"next_cursor":null}
request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Piemērs: "example"

Papildu lauki: Nē

Kļūdu katalogs

ErrorResponse · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
errorApiError Obligāts

Strukturēta kļūdas informācija.

Piemērs: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}
metaRequestMeta Obligāts

Atbildes metadati.

Piemērs: {"request_id":"example-request"}

Papildu lauki: Nē

Atsevišķu lauku validācijas kļūdas

FieldError · Shēma · Datu shēmas: Kopīgie modeļi
codeVirkneObligāts

Stabils mašīnlasāms kods.

Ierobežojumi
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldVirkneObligāts

Ar validācijas kļūdu saistītais lauks.

minLength: 1maxLength: 128
locationVirkneObligāts

Atrašanās vietas informācija.

Ierobežojumi
enum
["path", "query", "header", "body"]

Papildu lauki: Nē

Summa pirms atbildē parādītajiem papildu komponentiem

MoneyData · Shēma · Datu shēmas: Kopīgie modeļi
amountVirkneObligāts

Decimāla summa JSON virknes formā; null tikai tad, ja atļauts.

Piemērs: "0.00"
currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi
pattern
"^[A-Z]{3}$"
Piemērs: "PLN"
minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4
Piemērs: 2

Papildu lauki: Nē

Izveidot — Zīmoli — Atbilde

MutationData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
deletedLoģiska vērtībaObligāts

Vai dzēšana ir piemērota.

Piemērs: false
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (MutationData).

Piemērs: "example"
versionVesels skaitlis nullObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Atbildes metadati

PageMeta · Shēma · Datu shēmas: Kopīgie modeļi
paginationPagination Obligāts

Kursora lapošanas metadati.

Piemērs: {"has_more":false,"limit":20,"next_cursor":null}
request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Piemērs: "example"

Papildu lauki: Nē

Kursora lapošanas metadati

Pagination · Shēma · Datu shēmas: Kopīgie modeļi
has_moreLoģiska vērtībaObligāts

Vai ir pieejama nākamā lapa.

Piemērs: false
limitVesels skaitlisObligāts

Maksimālais ierakstu skaits šajā lapā.

minimum: 1maximum: 100
Piemērs: 20
next_cursorVirkne nullObligāts

Nākamās lapas turpinājuma vērtība vai null.

Piemērs: null

Papildu lauki: Nē

Atbildes metadati

RequestMeta · Shēma · Datu shēmas: Kopīgie modeļi
request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Piemērs: "example"

Papildu lauki: Nē