Guide pour l'intégration API des services d'expédition
1- Ajout colis : CreatePickup
Cette fonction permet la création des colis dans le système.
Input de l’API CreatePickup
| Élément |
Type |
Requis |
Valeurs autorisées |
Description |
| login |
String |
Oui |
— |
Login du compte expéditeur |
| pwd |
String |
Oui |
— |
Mot de passe du compte expéditeur |
| nom |
String |
Oui |
— |
Nom complet du client |
| gouvernerat |
String |
Oui |
Ariana, Béja, Ben Arous, Bizerte, Gabès, Gafsa, Jendouba, Kairouan, Kasserine, Kébili, La
Manouba, Le Kef,
Mahdia, Médenine, Monastir, Nabeul, Sfax, Sidi Bouzid, Siliana, Sousse, Tataouine, Tozeur,
Tunis, Zaghouan
|
Gouvernorat du client |
| ville |
String |
Oui |
— |
Ville du client |
| adresse |
String |
Oui |
— |
Adresse complète du client |
| tel |
Integer |
Oui |
— |
Numéro principal du client |
| tel2 |
Integer |
Non |
— |
Autre numéro du client |
| designation |
String |
Oui |
— |
Nom du produit |
| prix |
Float |
Oui |
— |
Valeur totale du colis |
| msg |
String |
Non |
— |
Commentaire |
| echange |
Integer |
Oui |
0 ou 1 |
1 si colis échange |
Output de l’API CreatePickup
| Élément |
Type |
Description |
| HasErrors |
Int |
0 pas d’erreur, 1 en cas d’erreur |
| ErrorsTxt |
String |
Description de l’erreur |
| CodeBarre |
BigInt |
Code barre du colis ajouté |
| Url |
String |
Lien d’impression du bon de commande du colis ajouté |
2- État d’un colis : TrackShipmentStatus
Cette fonction retourne l'état actuel d’un colis.
Input de l’API TrackShipmentStatus
| Élément |
Type |
Requis |
Valeurs autorisées |
Description |
| login |
String |
Oui |
— |
Login du compte expéditeur |
| pwd |
String |
Oui |
— |
Mot de passe du compte expéditeur |
| tracking_number |
BigInt |
Oui |
— |
Code barre d’un colis |
Output de l’API TrackShipmentStatus
| Élément |
Type |
Description |
| HasErrors |
Int |
0 pas d’erreur, 1 en cas d’erreur |
| ErrorsTxt |
String |
Description de l’erreur |
| tracking_number |
BigInt |
Code barre du colis |
| status |
Int |
État du colis (numérique) |
| message |
String |
État du colis (texte) |
3- Historique colis : TrackShipment
Cet API renvoie l'historique d’une commande.
Input de l’API TrackShipment
| Élément |
Type |
Requis |
Valeurs autorisées |
Description |
| login |
String |
Oui |
— |
Login du compte expéditeur |
| pwd |
String |
Oui |
— |
Mot de passe du compte expéditeur |
| tracking_number |
BigInt |
Oui |
— |
Code barre d’un colis |
Output de l’API TrackShipment
| Élément |
Type |
Description |
| HasErrors |
Int |
0 pas d’erreur, 1 en cas d’erreur |
| ErrorsTxt |
String |
Description de l’erreur |
| tracking_number |
BigInt |
Code barre du colis |
| status |
Array |
L’historique du colis (état et date) |
4- Liste des colis : GetOrder
Cet API renvoie la liste des colis.
Input de l’API GetOrder
| Élément |
Type |
Requis |
Valeurs autorisées |
Description |
| login |
String |
Oui |
— |
Login du compte expéditeur |
| pwd |
String |
Oui |
— |
Mot de passe du compte expéditeur |
| page |
Integer |
Non |
Numéro de page (par ex. 1) |
Page courante (optionnel) |
| ofset |
Integer |
Non |
Nombre d'enregistrements par page |
Optionnel, par défaut 10 |
Output de l’API GetOrder
| Élément |
Type |
Description |
| HasErrors |
Int |
0 pas d’erreur, 1 en cas d’erreur |
| ErrorsTxt |
String |
Description de l’erreur |
| status |
Int |
1 (succès) |
| total_pages |
Int |
Nombre total des pages |
| current_page |
Int |
Numéro de la page courante |
| message |
Array |
La liste des commandes |
5- Liste des recettes: GetRecette
Cet API renvoie la liste des recettes.
Input de l’API GetRecette
| Élément |
Type |
Requis |
Valeurs autorisées |
Description |
| login |
String |
Oui |
— |
Login du compte expéditeur |
| pwd |
String |
Oui |
— |
Mot de passe du compte expéditeur |
| page |
Integer |
Non |
Numéro de page (ex. 1) |
Page courante (optionnel) |
| ofset |
Integer |
Non |
Nombre d'enregistrements par page |
Optionnel, par défaut 10 |
Output de l’API GetRecette
| Élément |
Type |
Description |
| HasErrors |
Int |
0 pas d’erreur, 1 en cas d’erreur |
| ErrorsTxt |
String |
Description de l’erreur |
| status |
Int |
1 (succès) |
| total_pages |
Int |
Nombre total des pages |
| current_page |
Int |
Numéro de la page courante |
| message |
Array |
La liste des recettes |