REFERENCE

Modifier un colis

Modifiez directement un nouveau colis ou soumettez une demande traçable après ramassage.

Authentification et périmètre

Utilisez Authorization: Bearer VOTRE_CLE_API ou X-API-Key: VOTRE_CLE_API. La clé principale reste limitée aux colis de son compte. Une clé de sous-utilisateur en accès own est également limitée aux colis créés par ce sous-utilisateur.

Modifier les informations du colis

PATCH/parcels/{tracking_number}Clé API

Envoyez au moins un champ modifiable. Pour NEW_PARCEL, le changement est appliqué immédiatement. Pour PICKED_UP, SENT, RECEIVED ou IN_PROGRESS, l’API crée ou actualise une demande en attente d’approbation.

ChampTypeRègle
receiverstringNom du destinataire, 255 caractères maximum.
phonestringNuméro marocain mobile valide.
city_idintegerVille valide affectée à une zone de livraison.
amountnumberMontant positif ou nul.
addressstringAdresse, 500 caractères maximum.
notestringCommentaire, 1 000 caractères maximum.
cURL
curl -X PATCH 'https://clients.quicklivraison.ma/api/parcels/PARCEL_EXEMPLE' \
 -H 'Authorization: Bearer VOTRE_CLE_API' \
 -H 'Accept: application/json' -H 'Content-Type: application/json' \
 -d '{"city_id":123,"amount":349,"address":"Nouvelle adresse"}'
Réponse — modification directe
{"success":true,"tracking_number":"PARCEL_EXEMPLE","mode":"direct_update","request_id":null,"message":"Parcel updated."}
Réponse — approbation requise
{"success":true,"tracking_number":"PARCEL_EXEMPLE","mode":"pending_approval","request_id":42,"message":"Parcel edit request submitted for approval."}
Codes de succès200 signifie que le nouveau colis a été modifié immédiatement. 202 signifie que la demande a été enregistrée et attend une approbation.

Changer le destinataire

POST/parcels/{tracking_number}/recipient-changeClé API

Ce flux est disponible après ramassage pour les statuts autorisés. Il ne modifie jamais silencieusement le colis : il crée ou actualise une demande traçable en attente d’approbation.

cURL
curl -X POST 'https://clients.quicklivraison.ma/api/parcels/PARCEL_EXEMPLE/recipient-change' \
 -H 'X-API-Key: VOTRE_CLE_API' \
 -H 'Accept: application/json' -H 'Content-Type: application/json' \
 -d '{"receiver":"Nouveau destinataire","phone":"0612345678","city_id":123,"address":"Nouvelle adresse"}'

Traçabilité

  • Une modification directe ajoute une entrée détaillée dans l’historique du colis avec l’acteur API.
  • Une demande conserve les anciennes et nouvelles valeurs, l’acteur, l’heure et le type de demande.
  • Une nouvelle requête sur le même colis actualise la demande encore en attente au lieu de créer des doublons.
  • Le Sandbox valide la requête mais retourne persisted: false sans modifier les données.

Erreurs attendues

HTTPSignification
401Clé absente, invalide ou compte inactif.
404Colis inexistant ou non visible par cette clé.
409Statut non modifiable ou changement concurrent.
422Champ absent, invalide, ville hors zone ou aucune valeur réellement modifiée.