Format des réponses

Toutes les réponses de l’API Paps, en succès comme en erreur, partagent la même enveloppe.

{
  "code": 200,
  "message": "Success",
  "error": null,
  "data": {}
}

Champs

Champ	Type	Description
`code`	number	Code de statut de la réponse, aligné sur le code HTTP.
`message`	string	Message court décrivant le résultat de l’appel.
`error`	object \| null	`null` en cas de succès. Contient le détail de l’erreur en cas d’échec.
`data`	object	Contenu utile de la réponse. Sa structure dépend de l’endpoint appelé.

Exemple de succès

{
  "code": 200,
  "message": "Success",
  "error": null,
  "data": {
    "distance": 3435,
    "price": 12000,
    "packageSize": "XL",
    "size": 20
  }
}

Exemple d’erreur

{
  "code": 400,
  "message": "Bad Request",
  "error": {},
  "data": null
}

Le contenu exact du champ error (structure interne, codes d’erreur métier) n’est pas encore documenté de façon exhaustive. Voir la page Gestion des erreurs.

Statuts de livraison Vue d'ensemble

⌘I

Getting Started

Guides d'intégration

Concepts

API Reference

Resources

Format des réponses

Champs

Exemple de succès

Exemple d’erreur

​Champs

​Exemple de succès

​Exemple d’erreur

Champs

Exemple de succès

Exemple d’erreur