Mine sisu juurde
ShopentlyLearn
Eesti

Andmeskeemid: Ühised mudelid

Andmeskeemid: Ühised mudelid. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Struktureeritud veateave

ApiError · Skeem · Andmeskeemid: Ühised mudelid
codeStringKohustuslik

Püsiv masinloetav kood.

Piirangud
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"]
Näide: "authentication.invalid_credentials"
fieldsMassiiv <FieldError > nullValikuline

Üksikute väljade valideerimisvead.

Näide: null
messageStringKohustuslik

Inimloetav selgitus; programmiloogikas kasuta veakoodi.

Näide: "The credentials are invalid."

Lisaväljad: Ei

Loo — Brändid — Vastus

ApiResponse_MutationData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataMutationData Kohustuslik

Vastuse näide · MutationData.

Näide: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

Näide: {"request_id":"example"}

Lisaväljad: Ei

Vastuse metaandmed

ContextMeta · Skeem · Andmeskeemid: Ühised mudelid
localeStringKohustuslik

Selle päringu jaoks valitud keel.

Näide: "en"
market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

Näide: "PL"
market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Näide: "example"
request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Näide: "example"

Lisaväljad: Ei

Vastuse metaandmed

ContextPageMeta · Skeem · Andmeskeemid: Ühised mudelid
localeStringKohustuslik

Selle päringu jaoks valitud keel.

Näide: "en"
market_codeStringKohustuslik

Konteksti lõpp-punkti tagastatud turukood.

Näide: "PL"
market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Näide: "example"
paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

Näide: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Näide: "example"

Lisaväljad: Ei

Veakataloog

ErrorResponse · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
errorApiError Kohustuslik

Struktureeritud veateave.

Näide: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}
metaRequestMeta Kohustuslik

Vastuse metaandmed.

Näide: {"request_id":"example-request"}

Lisaväljad: Ei

Üksikute väljade valideerimisvead

FieldError · Skeem · Andmeskeemid: Ühised mudelid
codeStringKohustuslik

Püsiv masinloetav kood.

Piirangud
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldStringKohustuslik

Valideerimisveaga seotud väli.

minLength: 1maxLength: 128
locationStringKohustuslik

Asukohateave.

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

Lisaväljad: Ei

Summa enne vastuses näidatud lisakomponente

MoneyData · Skeem · Andmeskeemid: Ühised mudelid
amountStringKohustuslik

JSON-stringina kodeeritud kümnendsumma; null ainult lubatud juhtudel.

Näide: "0.00"
currencyStringKohustuslik

Summa valuutakood.

Piirangud
pattern
"^[A-Z]{3}$"
Näide: "PLN"
minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4
Näide: 2

Lisaväljad: Ei

Loo — Brändid — Vastus

MutationData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
deletedTõeväärtusKohustuslik

Kas kustutamine rakendati.

Näide: false
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (MutationData).

Näide: "example"
versionTäisarv nullKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

Vastuse metaandmed

PageMeta · Skeem · Andmeskeemid: Ühised mudelid
paginationPagination Kohustuslik

Kursoripõhise lehekülgjaotuse metaandmed.

Näide: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Näide: "example"

Lisaväljad: Ei

Kursoripõhise lehekülgjaotuse metaandmed

Pagination · Skeem · Andmeskeemid: Ühised mudelid
has_moreTõeväärtusKohustuslik

Kas järgmine leht on saadaval.

Näide: false
limitTäisarvKohustuslik

Kirjete maksimaalne arv sellel lehel.

minimum: 1maximum: 100
Näide: 20
next_cursorString nullKohustuslik

Järgmise lehe jätkuväärtus või null.

Näide: null

Lisaväljad: Ei

Vastuse metaandmed

RequestMeta · Skeem · Andmeskeemid: Ühised mudelid
request_idStringKohustuslik

Pöördumise identifikaator; vastuse metaandmetes tähistab see HTTP-päringut.

minLength: 1maxLength: 100
Näide: "example"

Lisaväljad: Ei