Base URL
https://shippinova.com/APIs/external/
Format
Toutes les réponses sont en application/json
Authentification
Header X-API-KEY ou Authorization: Bearer
APIs Expéditeur
SHIPPERCes endpoints utilisent une clé API de type expéditeur. Ils permettent de gérer les ordres de transport (OTR) depuis votre ERP ou système tiers.
Lister les OTRs
Récupérer la liste de vos ordres de transport avec filtres, pagination et tri.
Détail d'un OTR
Obtenir tous les détails d'un ordre de transport spécifique par son ID.
Créer un OTR
Créer un ordre de transport (client de votre carnet, transporteur partenaire, unités, emballages).
Modifier un OTR
Modifier un ordre de transport tant qu'il n'a pas été validé (adresses, dates, unités, références…).
Supprimer un OTR
Supprimer un ordre de transport tant qu'il n'a pas été validé (statut create).
Valider des OTRs
Valider un ou plusieurs OTR : le transporteur est prévenu et peut les traiter.
Télécharger un document
Générer la lettre de voiture CMR ou les étiquettes d'un OTR en PDF.
APIs Transporteur
CARRIERCes endpoints utilisent une clé API de type transporteur. Un abonnement actif est requis. Certains endpoints nécessitent un plan supérieur.
Lister les missions
Récupérer la liste des missions assignées à votre société, avec filtres par statut et pagination.
Détail d'une mission
Obtenir tous les détails d'une mission : expéditeur, destinataire, unités, documents, historique.
Mettre à jour le statut
Changer le statut d'une mission (en cours, livré, incident…) depuis votre TMS.
Upload preuve de livraison (POD)
Envoyer une photo ou signature électronique comme preuve de livraison (multipart/form-data).
Clore une mission
Marquer une mission comme définitivement terminée avec commentaire optionnel.
Signaler un incident
Déclarer un incident sur une mission (colis endommagé, retard, refus de livraison…).
Accepter / refuser une mission
Accepter ou refuser une mission qui vient d'être assignée à votre société.
Assigner un chauffeur
Affecter un chauffeur et un véhicule à une mission depuis votre TMS.
Historique d'une mission
Consulter tous les événements et changements de statut d'une mission.
Documents d'une mission
Récupérer la liste des documents associés à une mission (POD, LDV, bon de livraison…).
Résumé de mission
Obtenir un résumé condensé d'une mission (chauffeur, véhicule, statut, dernière position).
Lister les chauffeurs
Récupérer la liste des chauffeurs de votre société disponibles pour l'affectation.
Lister les véhicules
Récupérer la flotte de véhicules de votre société.
Authentification
Envoyer votre clé API
Deux formats acceptés, à choisir selon votre client HTTP :
Codes d'erreur HTTP
| Code | Signification | Corps JSON |
|---|---|---|
| 401 | Clé API absente | {"success":false,"error":"API key missing"} |
| 403 | Clé invalide ou désactivée | {"success":false,"error":"Invalid API key"} |
| 403 | Clé expéditeur sur un endpoint transporteur, ou l'inverse | {"success":false,"error":"API key not allowed for this endpoint","expected_owner_type":"transporteur","key_owner_type":"expediteur"} |
| 402 | Transporteur : abonnement inactif (essai terminé, résilié) | {"success":false,"error":"Subscription inactive","subscription":{"status":"expired","plan":"starter"}} |
| 403 | Transporteur : formule insuffisante pour cet endpoint | {"success":false,"error":"Plan upgrade required","required_plan":"pro","current_plan":"starter"} |
| 400 | Données invalides ou champ manquant | {"success":false,"error":"...","code":"VALIDATION_ERROR","field_errors":{...}} |
| 404 | Ressource introuvable pour votre société (OTR, mission…) | {"success":false,"error":"..."} |
| 409 / 422 | Action impossible dans l'état actuel (OTR déjà validé, transporteur non partenaire…) | {"success":false,"error":"...","code":"..."} |
| 429 | Trop de requêtes (en-tête Retry-After: 60) | {"success":false,"error":"Rate limit exceeded","limits":{"per_minute":120,"per_day":20000},"usage":{...}} |
| 500 | Erreur serveur interne | {"success":false,"error":"..."} |
Exemple curl
curl -i -X GET "https://shippinova.com/APIs/external/get_otrs.php?limit=10" \ -H "X-API-KEY: votre_cle_api"
curl -i -X POST "https://shippinova.com/APIs/external/carrier_update_mission_status.php" \
-H "X-API-KEY: votre_cle_api" \
-H "Content-Type: application/json" \
-d '{"otr_id":123,"status":"livre"}'
Plans d'abonnement Transporteur
Les endpoints transporteur vérifient l'abonnement de votre société : un abonnement inactif renvoie 402, une formule insuffisante 403. Les expéditeurs ne sont pas concernés. Prix et détail des formules : page Tarifs.
- Lister les missions
- Détail d'une mission
- Mettre à jour le statut
- Upload POD
- Clore une mission
- Signaler un incident
- Lister chauffeurs et véhicules
- Historique et documents
- Accepter / refuser une mission
- Assigner un chauffeur (TMS)
- Tout le plan Starter
- Accepter / refuser une mission
- Assigner un chauffeur et un véhicule
- Tous les endpoints
- Jusqu'à 200 chauffeurs et 200 véhicules
Limites de requêtes
Les limites s'appliquent par clé API et par endpoint, et sont les mêmes pour toutes les formules. Au-delà, la réponse est HTTP 429 avec l'en-tête Retry-After: 60.