Hoppa till innehållet
ShopentlyLearn
Svenska

Datascheman: Gemensamma modeller

Datascheman: Gemensamma modeller. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Strukturerad felinformation

ApiError · Schema · Datascheman: Gemensamma modeller
codeSträngObligatoriskt

Stabil maskinläsbar kod.

Begränsningar
enum
["storage.limit_reached", "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", "request.range_not_satisfiable", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]
Exempel: "resource.state_conflict"
fieldsArray <FieldError > nullValfritt

Valideringsfel för enskilda fält.

Exempel: null
messageSträngObligatoriskt

Läsbar förklaring; använd felkoden i programlogiken.

Exempel: "The current resource state does not allow this operation."

Ytterligare fält: Nej

Skapa — Varumärken — Svar

ApiResponse_MutationData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataMutationData Obligatoriskt

Exempel på svar · MutationData.

Exempel: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoriskt

Metadata för svaret.

Exempel: {"request_id":"example"}

Ytterligare fält: Nej

Metadata för svaret

ContextMeta · Schema · Datascheman: Gemensamma modeller
localeSträngObligatoriskt

Språk valt för denna begäran.

Exempel: "en"
market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

Exempel: "PL"
market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Exempel: "example"
request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel: "example"

Ytterligare fält: Nej

Metadata för svaret

ContextPageMeta · Schema · Datascheman: Gemensamma modeller
localeSträngObligatoriskt

Språk valt för denna begäran.

Exempel: "en"
market_codeSträngObligatoriskt

Marknadskod returnerad av kontextendpointen.

Exempel: "PL"
market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Exempel: "example"
paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

Exempel: {"has_more":false,"limit":20,"next_cursor":null}
request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel: "example"

Ytterligare fält: Nej

Felkatalog

ErrorResponse · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
errorApiError Obligatoriskt

Strukturerad felinformation.

Exempel: {"code":"resource.state_conflict","fields":null,"message":"The current resource state does not allow this operation."}
metaRequestMeta Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Valideringsfel för enskilda fält

FieldError · Schema · Datascheman: Gemensamma modeller
codeSträngObligatoriskt

Stabil maskinläsbar kod.

Begränsningar
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldSträngObligatoriskt

Fält som hör till ett valideringsfel.

minLength: 1maxLength: 128
locationSträngObligatoriskt

Platsinformation.

Begränsningar
enum
["path", "query", "header", "body"]

Ytterligare fält: Nej

Belopp före de tillägg som visas i svaret

MoneyData · Schema · Datascheman: Gemensamma modeller
amountSträngObligatoriskt

Decimalbelopp kodat som JSON-sträng; null endast där det tillåts. Skicka belopp som text med decimalpunkt, till exempel "19.99", enligt fältets beskrivning. Använd en decimaltyp för beräkningar för att undvika precisionsfel.

Exempel: "0.00"
currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar
pattern
"^[A-Z]{3}$"
Exempel: "PLN"
minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4
Exempel: 2

Ytterligare fält: Nej

Skapa — Varumärken — Svar

MutationData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
deletedBooleskt värdeObligatoriskt

Anger om borttagningen utfördes.

Exempel: false
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (MutationData).

Exempel: "example"
versionHeltal nullObligatoriskt

Resursversion för samtidighetskontroll. Vissa versionsnummer kan överstiga Number.MAX_SAFE_INTEGER i JavaScript. Läs och skicka dem utan att ändra siffrorna. I JSON ska de vara tal, inte text.

Exempel: 1

Ytterligare fält: Nej

Metadata för svaret

PageMeta · Schema · Datascheman: Gemensamma modeller
paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

Exempel: {"has_more":false,"limit":20,"next_cursor":null}
request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel: "example"

Ytterligare fält: Nej

Metadata för markörbaserad paginering

Pagination · Schema · Datascheman: Gemensamma modeller
has_moreBooleskt värdeObligatoriskt

Anger om det finns ytterligare en sida.

Exempel: false
limitHeltalObligatoriskt

Högsta antal poster på denna sida.

minimum: 1maximum: 100
Exempel: 20
next_cursorSträng nullObligatoriskt

Fortsättningsvärde för nästa sida, eller null.

Exempel: null

Ytterligare fält: Nej

Metadata för svaret

RequestMeta · Schema · Datascheman: Gemensamma modeller
request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel: "example-request"

Ytterligare fält: Nej