Gå til indhold
ShopentlyLearn
Dansk

Dataskemaer: Fælles modeller

Dataskemaer: Fælles modeller. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Strukturerede fejloplysninger

ApiError · Skema · Dataskemaer: Fælles modeller
codeStrengObligatorisk

Stabil maskinlæsbar kode.

Begrænsninger
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 > nullValgfrit

Valideringsfejl for de enkelte felter.

Eksempel: null
messageStrengObligatorisk

Menneskeligt læsbar forklaring; brug fejlkoden i programlogikken.

Eksempel: "The credentials are invalid."

Yderligere felter: Nej

Opret — Mærker — Svar

ApiResponse_MutationData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Svarmetadata

ContextMeta · Skema · Dataskemaer: Fælles modeller
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

Eksempel: "en"
market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

Eksempel: "PL"
market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Eksempel: "example"
request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel: "example"

Yderligere felter: Nej

Svarmetadata

ContextPageMeta · Skema · Dataskemaer: Fælles modeller
localeStrengObligatorisk

Sprog valgt til denne forespørgsel.

Eksempel: "en"
market_codeStrengObligatorisk

Markedskode returneret af kontekstendepunktet.

Eksempel: "PL"
market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Eksempel: "example"
paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

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

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel: "example"

Yderligere felter: Nej

Fejlkatalog

ErrorResponse · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
errorApiError Obligatorisk

Strukturerede fejloplysninger.

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

Svarmetadata.

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

Yderligere felter: Nej

Valideringsfejl for de enkelte felter

FieldError · Skema · Dataskemaer: Fælles modeller
codeStrengObligatorisk

Stabil maskinlæsbar kode.

Begrænsninger
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldStrengObligatorisk

Felt knyttet til en valideringsfejl.

minLength: 1maxLength: 128
locationStrengObligatorisk

Placeringsoplysninger.

Begrænsninger
enum
["path", "query", "header", "body"]

Yderligere felter: Nej

Beløb før de yderligere bestanddele vist i svaret

MoneyData · Skema · Dataskemaer: Fælles modeller
amountStrengObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Eksempel: "0.00"
currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger
pattern
"^[A-Z]{3}$"
Eksempel: "PLN"
minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4
Eksempel: 2

Yderligere felter: Nej

Opret — Mærker — Svar

MutationData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
deletedBoolesk værdiObligatorisk

Om sletningen blev udført.

Eksempel: false
idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (MutationData).

Eksempel: "example"
versionHeltal nullObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Svarmetadata

PageMeta · Skema · Dataskemaer: Fælles modeller
paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

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

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel: "example"

Yderligere felter: Nej

Metadata for markørbaseret sideinddeling

Pagination · Skema · Dataskemaer: Fælles modeller
has_moreBoolesk værdiObligatorisk

Om der findes endnu en side.

Eksempel: false
limitHeltalObligatorisk

Maksimalt antal poster på denne side.

minimum: 1maximum: 100
Eksempel: 20
next_cursorStreng nullObligatorisk

Fortsættelsesværdi for næste side eller null.

Eksempel: null

Yderligere felter: Nej

Svarmetadata

RequestMeta · Skema · Dataskemaer: Fælles modeller
request_idStrengObligatorisk

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel: "example"

Yderligere felter: Nej