Les colis par l'API
Ces routes font ce que font les écrans Colis. Chaque colis ajouté utilise un suivi de votre solde.
| Route | Scope | Fait |
|---|---|---|
POST /v1/parcel/create | parcel:write | ajoute un colis, ou jusqu'à 100 avec {"items": [...]} |
GET /v1/parcel/list | parcel:read | liste vos colis |
GET /v1/parcel/detail/<id> | parcel:read | un colis avec ses événements de suivi, du plus récent au plus ancien |
PATCH /v1/parcel/detail/<id> | parcel:write | modifie les champs envoyés |
DELETE /v1/parcel/detail/<id> | parcel:write | supprime le colis, comme l'écran |
Ajouter un colis
Envoyez tracking_number (5 à 50 caractères : lettres, chiffres et - _ . /) et le transporteur, en carrier_id (lu dans GET /v1/carrier/list) ou en carrier_code :
curl -X POST https://api.logistic.ultineo.com/v1/parcel/create \
-H "Authorization: Bearer VOTRE_CLE" -H "Content-Type: application/json" \
-d '{"tracking_number": "1Z999AA10123456784", "carrier_code": "100002"}' La réponse est 201 avec le colis. Un numéro de suivi déjà suivi n'est jamais ajouté deux fois : un colis seul répond 409 avec l'id qui le détient, et dans un lot cet élément répond existing. Vous pouvez donc renvoyer toute la liste après un échec.
Suivre vos colis
Le suivi est lu auprès du transporteur après l'ajout du colis, pas pendant l'appel. Relisez le colis avec GET /v1/parcel/detail/<id>, ou tenez une liste à jour : appelez une fois GET /v1/parcel/list?updated_since=<heure Unix>, puis appelez-la avec ?cursor= et le next_cursor de la réponse précédente.
La liste filtre aussi sur status, tracking_number, carrier, recipient, shipment et q.
Mettre en pause, relancer ou rafraîchir un colis
Envoyez un PATCH avec "tracking": "paused" ou "tracking": "active", ou "refresh": true pour interroger de nouveau le transporteur. Changer tracking_number ou le transporteur relance le suivi pour le nouveau numéro.