Aller au contenu principal

API Bons de Commande

Vue d'ensemble​

L'API des bons de commande permet de consulter et télécharger les bons de commande en format PDF.

Endpoints disponibles​

Liste des bons de commande​

GET /api/privee/bon-commande

Paramètres optionnels:

  • page (number): Numéro de page (défaut: 1)
  • limit (number): Éléments par page (défaut: 10)

Exemple:

curl -X GET "https://.../api/privee/bon-commande?page=1&limit=20"

Réponse:

{
  "data": [
    {
      "id": 1,
      "restockId": 12345,
      "storeId": 5,
      "deliveryDate": "2025-11-10T00:00:00.000Z",
      "date": "2025-11-06T10:30:00.000Z",
      "createdAt": "2025-11-06T10:30:00.000Z"
    }
  ],
  "pageNumber": 1,
  "pageLimit": 20,
  "totalItems": 1,
  "totalPages": 1
}

Détails d'un bon de commande​

GET /api/privee/bon-commande/:id

Paramètres:

  • id (number): ID du bon de commande

Exemple:

curl -X GET "/api/privee/bon-commande/1"

Télécharger un bon de commande en PDF​

GET /api/privee/bon-commande/:id/pdf

Paramètres:

  • id (number): ID du bon de commande

Exemple:

curl -X GET "https://.../api/privee/bon-commande/1/pdf" \
  --output bon-commande-12345.pdf

Réponse:

  • Type: application/pdf
  • Nom du fichier: bon-commande-{restockId}.pdf

Contenu du PDF:

  • Numéro du bon de commande
  • Nom et adresse du magasin
  • Date de commande et de livraison
  • Liste des articles (ID, nom, quantité)
  • Total des articles
  • Date de génération

Note: Les prix ne sont pas inclus dans le PDF.

Codes de réponse​

  • 200: Succès
  • 404: Bon de commande non trouvé
  • 500: Erreur serveur