Gå til innhold
ShopentlyLearn
Norsk bokmål

Dataskjemaer: Felles modeller

Dataskjemaer: Felles modeller. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Strukturert feilinformasjon

ApiError · Skjema · Dataskjemaer: Felles modeller
codeStrengObligatorisk

Stabil maskinlesbar kode.

Begrensninger
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"]
Eksempel: "authentication.invalid_credentials"
fieldsArray <FieldError > nullValgfritt

Valideringsfeil for enkeltfelt.

Eksempel: null
messageStrengObligatorisk

Menneskelesbar forklaring; bruk feilkoden i programlogikken.

Eksempel: "The credentials are invalid."

Ytterligere felt: Nei

Opprett — Merker — Svar

ApiResponse_MutationData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataMutationData Obligatorisk

Eksempel på svar · MutationData.

Eksempel: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorisk

Svarmetadata.

Eksempel: {"request_id":"example"}

Ytterligere felt: Nei

Svarmetadata

ContextMeta · Skjema · Dataskjemaer: Felles modeller
localeStrengObligatorisk

Språk valgt for denne forespørselen.

Eksempel: "en"
market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

Eksempel: "PL"
market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Eksempel: "example"
request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel: "example"

Ytterligere felt: Nei

Svarmetadata

ContextPageMeta · Skjema · Dataskjemaer: Felles modeller
localeStrengObligatorisk

Språk valgt for denne forespørselen.

Eksempel: "en"
market_codeStrengObligatorisk

Markedskode returnert av kontekstendepunktet.

Eksempel: "PL"
market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Eksempel: "example"
paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

Eksempel: {"has_more":false,"limit":20,"next_cursor":null}
request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel: "example"

Ytterligere felt: Nei

Feilkatalog

ErrorResponse · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
errorApiError Obligatorisk

Strukturert feilinformasjon.

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

Svarmetadata.

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

Ytterligere felt: Nei

Valideringsfeil for enkeltfelt

FieldError · Skjema · Dataskjemaer: Felles modeller
codeStrengObligatorisk

Stabil maskinlesbar kode.

Begrensninger
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldStrengObligatorisk

Felt knyttet til en valideringsfeil.

minLength: 1maxLength: 128
locationStrengObligatorisk

Plasseringsinformasjon.

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

Ytterligere felt: Nei

Beløp før de ytterligere bestanddelene vist i svaret

MoneyData · Skjema · Dataskjemaer: Felles modeller
amountStrengObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløpet.

Begrensninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
minor_unitsHeltallObligatorisk

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4
Eksempel: 2

Ytterligere felt: Nei

Opprett — Merker — Svar

MutationData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
deletedBoolsk verdiObligatorisk

Om slettingen ble utført.

Eksempel: false
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (MutationData).

Eksempel: "example"
versionHeltall nullObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Svarmetadata

PageMeta · Skjema · Dataskjemaer: Felles modeller
paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

Eksempel: {"has_more":false,"limit":20,"next_cursor":null}
request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel: "example"

Ytterligere felt: Nei

Metadata for markørbasert sideinndeling

Pagination · Skjema · Dataskjemaer: Felles modeller
has_moreBoolsk verdiObligatorisk

Om enda en side er tilgjengelig.

Eksempel: false
limitHeltallObligatorisk

Maksimalt antall oppføringer på denne siden.

minimum: 1maximum: 100
Eksempel: 20
next_cursorStreng nullObligatorisk

Fortsettelsesverdi for neste side, eller null.

Eksempel: null

Ytterligere felt: Nei

Svarmetadata

RequestMeta · Skjema · Dataskjemaer: Felles modeller
request_idStrengObligatorisk

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel: "example"

Ytterligere felt: Nei