Aller au contenu
ShopentlyLearn

Requêtes et réponses

Interprétez ensemble le statut HTTP, les données JSON typées et les métadonnées.

Requête

Content-Type: application/json
Envoyez les écritures JSON avec Content-Type: application/json.
data · meta
Les réponses réussies contiennent data et meta ; les collections décrivent aussi la pagination.
error.code · error.message
Les erreurs contiennent error.code, error.message et, le cas échéant, des informations sur les champs.

Types de données

  • Le caractère obligatoire et l'autorisation de null sont indépendants.
  • Un champ obligatoire peut contenir null si son schéma le permet.
  • Conservez les booléens, entiers, chaînes et null sans conversion de type.
  • Les montants sont des chaînes décimales ; ne calculez pas les prix en virgule flottante binaire.

64-bit · expected_version

  • Certaines versions de concurrence utilisent des entiers signés sur 64 bits.
  • Un client JavaScript doit traiter sans perte les valeurs JSON dépassant Number.MAX_SAFE_INTEGER et envoyer la représentation entière d'origine.
  • N'arrondissez pas une version et ne la convertissez pas en chaîne JSON.

En-têtes

Cache-ControlChaîneFacultatif

Règles de mise en cache de la réponse.

const: "no-store"
X-Correlation-IDChaîneFacultatif

Identifiant permettant de suivre cette requête HTTP.

WWW-AuthenticateChaîneFacultatif

Schéma d'authentification exigé par le serveur.

AllowChaîneFacultatif

Méthodes HTTP prises en charge par cette ressource.

Retry-AfterEntierFacultatif

Délai minimal avant une nouvelle tentative, en secondes.

minimum: 0
LocationChaîneFacultatif

URL relative de la ressource créée.