Gå til innhold
ShopentlyLearn

Forespørsler og svar

Les HTTP-status, typet JSON-innhold og forespørselens metadata samlet.

Forespørsel

Content-Type: application/json
Send JSON-skriveoperasjoner med Content-Type: application/json.
data · meta
Vellykkede svar inneholder data og meta; svar med samlinger beskriver også sideinndeling.
error.code · error.message
Feil inneholder error.code, error.message og feltinformasjon der det er relevant.

Datatyper

  • Obligatorisk og nullable er uavhengige egenskaper.
  • Et obligatorisk felt kan gyldig inneholde null når skjemaet tillater det.
  • Bevar boolske JSON-verdier, heltall, strenger og null uten typekonvertering.
  • Pengebeløp er desimalstrenger; ikke beregn priser med binære flyttall.

64-bit · expected_version

  • Noen versjoner for samtidighetskontroll bruker 64-bit heltall med fortegn.
  • En JavaScript-klient må håndtere JSON uten presisjonstap for verdier over Number.MAX_SAFE_INTEGER og sende den opprinnelige heltallsrepresentasjonen.
  • Ikke rund av en versjon eller konverter den til en JSON-streng.

Headere

Cache-ControlStrengValgfritt

Regler for mellomlagring av svaret.

const: "no-store"
X-Correlation-IDStrengValgfritt

Identifikator for sporing av denne HTTP-forespørselen.

WWW-AuthenticateStrengValgfritt

Autentiseringsmetode serveren krever.

AllowStrengValgfritt

HTTP-metoder denne ressursen støtter.

Retry-AfterHeltallValgfritt

Minste ventetid før neste forsøk, i sekunder.

minimum: 0
LocationStrengValgfritt

Relativ URL til ressursen som ble opprettet.