Aqbeż għall-kontenut
ShopentlyLearn
Malti

Skemi tad-data: Mudelli komuni

Skemi tad-data: Mudelli komuni. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Informazzjoni strutturata tal-iżball

ApiError · Skema · Skemi tad-data: Mudelli komuni
codeStringObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet
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"]
Eżempju: "authentication.invalid_credentials"
fieldsArray <FieldError > nullMhux obbligatorju

Żbalji tal-validazzjoni tal-oqsma individwali.

Eżempju: null
messageStringObbligatorju

Spjegazzjoni għall-bniedem; uża l-kodiċi tal-iżball għal-loġika tal-programm.

Eżempju: "The credentials are invalid."

Oqsma addizzjonali: Le

Oħloq — Marki — Risposta

ApiResponse_MutationData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
dataMutationData Obbligatorju

Eżempju ta’ tweġiba · MutationData.

Eżempju: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju

Metadata tat-tweġiba.

Eżempju: {"request_id":"example"}

Oqsma addizzjonali: Le

Metadata tat-tweġiba

ContextMeta · Skema · Skemi tad-data: Mudelli komuni
localeStringObbligatorju

Lingwa magħżula għal din it-talba.

Eżempju: "en"
market_codeStringObbligatorju

Kodiċi tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "PL"
market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "example"
request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100
Eżempju: "example"

Oqsma addizzjonali: Le

Metadata tat-tweġiba

ContextPageMeta · Skema · Skemi tad-data: Mudelli komuni
localeStringObbligatorju

Lingwa magħżula għal din it-talba.

Eżempju: "en"
market_codeStringObbligatorju

Kodiċi tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "PL"
market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Eżempju: "example"
paginationPagination Obbligatorju

Metadata tal-paġinazzjoni bil-cursor.

Eżempju: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100
Eżempju: "example"

Oqsma addizzjonali: Le

Katalgu tal-iżbalji

ErrorResponse · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
errorApiError Obbligatorju

Informazzjoni strutturata tal-iżball.

Eżempju: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}
metaRequestMeta Obbligatorju

Metadata tat-tweġiba.

Eżempju: {"request_id":"example-request"}

Oqsma addizzjonali: Le

Żbalji tal-validazzjoni tal-oqsma individwali

FieldError · Skema · Skemi tad-data: Mudelli komuni
codeStringObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
fieldStringObbligatorju

Qasam assoċjat ma’ żball ta’ validazzjoni.

minLength: 1maxLength: 128
locationStringObbligatorju

Informazzjoni dwar il-post.

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

Oqsma addizzjonali: Le

Ammont qabel il-komponenti addizzjonali murija fit-tweġiba

MoneyData · Skema · Skemi tad-data: Mudelli komuni
amountStringObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

Eżempju: "0.00"
currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet
pattern
"^[A-Z]{3}$"
Eżempju: "PLN"
minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4
Eżempju: 2

Oqsma addizzjonali: Le

Oħloq — Marki — Risposta

MutationData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.
deletedBooleanObbligatorju

Jekk it-tħassir ġiex applikat.

Eżempju: false
idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (MutationData).

Eżempju: "example"
versionNumru sħiħ nullObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Metadata tat-tweġiba

PageMeta · Skema · Skemi tad-data: Mudelli komuni
paginationPagination Obbligatorju

Metadata tal-paġinazzjoni bil-cursor.

Eżempju: {"has_more":false,"limit":20,"next_cursor":null}
request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100
Eżempju: "example"

Oqsma addizzjonali: Le

Metadata tal-paġinazzjoni bil-cursor

Pagination · Skema · Skemi tad-data: Mudelli komuni
has_moreBooleanObbligatorju

Jekk hemmx paġna oħra disponibbli.

Eżempju: false
limitNumru sħiħObbligatorju

Numru massimu ta’ rekords f’din il-paġna.

minimum: 1maximum: 100
Eżempju: 20
next_cursorString nullObbligatorju

Valur ta’ kontinwazzjoni għall-paġna li jmiss, jew null.

Eżempju: null

Oqsma addizzjonali: Le

Metadata tat-tweġiba

RequestMeta · Skema · Skemi tad-data: Mudelli komuni
request_idStringObbligatorju

Identifikatur tat-talba; fil-metadata tat-tweġiba jidentifika t-talba HTTP.

minLength: 1maxLength: 100
Eżempju: "example"

Oqsma addizzjonali: Le