Aller au contenu principal

API Reference

Cette page recense les contrats API à documenter pour maintenir la documentation chatbot alignée avec les évolutions backend, Logidav et UI.

Ordre de source de vérité

  1. Code mergé et contrats backend actifs.
  2. Docs internes backend versionnées.
  3. Comportement Logidav actuellement déployé.
  4. UI chatbot visible par le client.
  5. Ticket produit ou validation métier.

Si deux sources divergent, la page doit mentionner le point à valider au lieu de figer une règle incertaine.

SAV

SujetEndpoint ou contratStatut documentation
Création SAVPOST /api/v2/sav/requestsÀ détailler par type SAV.
Bon d'achat remboursement +40%Type SAV refund-voucherIntégré au guide Relance remboursement, contrat API à compléter.
Relances SLAPOST /api/v2/sav/validations/reminder-slaÀ documenter avec matrice délais / limites.
Oubli code promo/api/v2/sav/forgotten-coupon/eligibility, /api/v2/sav/forgotten-coupon/ticketÀ documenter.
Notifications erreurs SAVPOST /api/v2/sav/error-notificationsÀ documenter avec catalogue erreurs.

Commandes

SujetEndpoint ou contratStatut documentation
Éligibilité annulationGET /api/v2/orders/{reference}/cancellation-eligibilityÀ documenter.
État support commandeGET /api/v2/orders/{reference}/support-stateÀ documenter.
État réexpéditionGET /api/v2/orders/{reference}/reshipment-stateÀ documenter.
Éligibilité pièce manquantePOST /api/v2/orders/{reference}/missing-part-eligibilityÀ documenter.

Livraison

SujetEndpoint ou contratStatut documentation
Options de livraison/v2/delivery/optionsÀ documenter.
Changement de méthode/v2/delivery/changeÀ documenter.
Statut paiement changement livraison/v2/delivery/payment-status/{changeId}À documenter.
Mise à jour données livraisonupdate-shipment-details / delivery-info-updateÀ valider avant documentation définitive.

Client

SujetEndpoint ou contratStatut documentation
Mise à jour emailPOST /api/v2/customers/email-update/initiate, POST /api/v2/customers/email-update/verifyÀ documenter.

Critères attendus pour chaque endpoint

Chaque contrat API ajouté doit préciser :

  • l'objectif métier,
  • les permissions ou scopes requis,
  • les paramètres d'entrée,
  • les réponses nominales,
  • les erreurs fonctionnelles,
  • les erreurs techniques,
  • les règles de test ou suffixes de référence si applicables,
  • l'impact côté chatbot, backend et Logidav.