Pereiti prie turinio
ShopentlyLearn
Lietuvių

Duomenų schemos: Bendrieji modeliai

Duomenų schemos: Bendrieji modeliai. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Struktūrinė klaidos informacija

ApiError · Schema · Duomenų schemos: Bendrieji modeliai
codeEilutėPrivalomas

Stabilus kompiuterio skaitomas kodas.

Apribojimai
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"]
Pavyzdys: "authentication.invalid_credentials"
fieldsMasyvas <FieldError > nullNeprivalomas

Atskirų laukų tikrinimo klaidos.

Pavyzdys: null
messageEilutėPrivalomas

Žmogui skirtas paaiškinimas; programos logikoje naudokite klaidos kodą.

Pavyzdys: "The credentials are invalid."

Papildomi laukai: Ne

Sukurti — Prekių ženklai — Atsakymas

ApiResponse_MutationData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataMutationData Privalomas

Atsakymo pavyzdys · MutationData.

Pavyzdys: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example"}

Papildomi laukai: Ne

Atsakymo metaduomenys

ContextMeta · Schema · Duomenų schemos: Bendrieji modeliai
localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

Pavyzdys: "en"
market_codeEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

Pavyzdys: "PL"
market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Pavyzdys: "example"
request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Pavyzdys: "example"

Papildomi laukai: Ne

Atsakymo metaduomenys

ContextPageMeta · Schema · Duomenų schemos: Bendrieji modeliai
localeEilutėPrivalomas

Šiai užklausai pasirinkta kalba.

Pavyzdys: "en"
market_codeEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos kodas.

Pavyzdys: "PL"
market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Pavyzdys: "example"
paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

Pavyzdys: {"has_more":false,"limit":20,"next_cursor":null}
request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Pavyzdys: "example"

Papildomi laukai: Ne

Klaidų katalogas

ErrorResponse · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
errorApiError Privalomas

Struktūrinė klaidos informacija.

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

Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Atskirų laukų tikrinimo klaidos

FieldError · Schema · Duomenų schemos: Bendrieji modeliai
codeEilutėPrivalomas

Stabilus kompiuterio skaitomas kodas.

Apribojimai
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldEilutėPrivalomas

Su tikrinimo klaida susijęs laukas.

minLength: 1maxLength: 128
locationEilutėPrivalomas

Vietos informacija.

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

Papildomi laukai: Ne

Suma prieš papildomus atsakyme parodytus komponentus

MoneyData · Schema · Duomenų schemos: Bendrieji modeliai
amountEilutėPrivalomas

Dešimtainė suma, užkoduota JSON eilute; null tik ten, kur leidžiama.

Pavyzdys: "0.00"
currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai
pattern
"^[A-Z]{3}$"
Pavyzdys: "PLN"
minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4
Pavyzdys: 2

Papildomi laukai: Ne

Sukurti — Prekių ženklai — Atsakymas

MutationData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
deletedLoginė reikšmėPrivalomas

Ar šalinimas buvo atliktas.

Pavyzdys: false
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (MutationData).

Pavyzdys: "example"
versionSveikasis skaičius nullPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Atsakymo metaduomenys

PageMeta · Schema · Duomenų schemos: Bendrieji modeliai
paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

Pavyzdys: {"has_more":false,"limit":20,"next_cursor":null}
request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Pavyzdys: "example"

Papildomi laukai: Ne

Skaidymo į puslapius pagal žymeklį metaduomenys

Pagination · Schema · Duomenų schemos: Bendrieji modeliai
has_moreLoginė reikšmėPrivalomas

Ar yra kitas puslapis.

Pavyzdys: false
limitSveikasis skaičiusPrivalomas

Didžiausias įrašų skaičius šiame puslapyje.

minimum: 1maximum: 100
Pavyzdys: 20
next_cursorEilutė nullPrivalomas

Kito puslapio tęsimo reikšmė arba null.

Pavyzdys: null

Papildomi laukai: Ne

Atsakymo metaduomenys

RequestMeta · Schema · Duomenų schemos: Bendrieji modeliai
request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Pavyzdys: "example"

Papildomi laukai: Ne