FAQ API v1 Boxtal

1. Comment tester le passage de commande ?
2. Y a t'il moyen de supprimer une commande à partir de la boutique e-commerce ?
3. Comment afficher les points relais en fonction des transporteur ?
4. Quelle url donner à mon client pour le suivi de la commande ?
5. Comment obtenir le numéro de suivi du transporteur ?
6. Je n'arrive pas à passer commande [bad_request]
7. Exemple de requête avec une proforma
8. Comment effectuer une cotation sur un point relais (operateur/service) précis?

 

#1. Comment tester le passage de commande ?

Il n'existe pas pour le moment un environnement de test. Vous pouvez passer des commandes en production et les annuler par la suite, depuis le compte client sur www.boxtal.com. Si le bordereau est utilisé pour un envoi, l'annulation ne sera plus possible.

#2. Y a t'il moyen de supprimer/annuler une commande à partir de la boutique e-commerce ?

Non, il faut le faire depuis le compte client sur www.boxtal.com. 

#3. Comment afficher les points relais en fonction des transporteur (laposte, chronopost ...)?

Pour récupérer les points relais via l'API utilisez une requête de type :

http://www.envoimoinscher.com/api/v1/listpoints?collecte=dest&pays=FR&cp=code_postal&ville=ville

Cette requête retourne 30 points relais par transporteur, tout transporteur confondu. Pour trier par transporteur(s), utilisez le paramètre carriers qui est un tableau.

Voici le mapping transporteurs - codes points relais:

• Mondial Relay : MONR-xxxxxx
• Relais Colis : SOGP-xxxx
• UPS : UPSE-xxxx
• Happy Post : IMXE-xxxxx
• Chronopost : CHRP-xxxxx

#4. Quelle url donner à mon client pour le suivi de la commande ?

Pour suivre la livraison du colis, lors du passage de commande ajoutez une url de push en paramètre: les informations de suivi seront envoyées par notre API au fur et à mesure que le transporteur met à jour ces informations.

Plus d'info sur le fonctionnement de l'url de push dans la section "URL de push" https://www.boxtal.com/fr/fr/api

#5. Comment obtenir le numéro de suivi du transporteur ?

Vous pouvez récupérer le numéro de suivi du transporteur en interrogeant l'état de la commande (voir section "État de la commande" https://www.boxtal.com/fr/fr/api)

La référence du transporteur se trouve au niveau du champ carrier_reference .

#6. Je n'arrive pas à passer commande [bad_request]

1. Please specify the good carrier service. There are xx quotes, but wanted 1

Les champs operator et/ou service ne sont pas valides donc il n'est pas possible de choisir une seule offre de transport pour passer commande.

Pour connaîntre la liste des operateurs et des services lancez une cotation (voir séction 'Commande' dans la documentation API v1).

Les valeurs service se trouvent au niveau de /*/*/offer/service/code

Les valeurs operator se trouvent au niveau de /*/*/offer/operator/code

#7 Exemple de requête avec proforma

http://www.envoimoinscher.com/api/v1/order?module_version=1.1.5&expediteur.type=entreprise&expediteur.civilite=M&expediteur.nom=Test&expediteur.prenom=Test&expediteur.societe=Soci%C3%A9t%C3%A9&expediteur.email=contact%40test.com&expediteur.tel=0600000000&expediteur.adresse=30%20Rue%20Raspail&expediteur.code_postal=93120&expediteur.ville=La%20Courneuve&expediteur.pays=FR&destinataire.type=particulier&destinataire.civilite=M&destinataire.nom=Test&destinataire.prenom=Test&destinataire.adresse=24%20rue%20des%20pommaries&destinataire.ville=Annecy%20le%20vieux&destinataire.code_postal=74940&destinataire.tel=0600000000&destinataire.email=test%40gmail.com&destinataire.pays=FR&code_contenu=10120&colis.description=Newspapers&colis_0.largeur=27&colis_0.longueur=37&colis_0.hauteur=3.63&colis_0.poids=2.4684&colis.valeur=100&type_emballage.emballage=1-Bo%C3%AEte&operateur=UPSE&service=Standard&delai=aucun&collecte=2019-03-15&disponibilite.HDE=09%3A00&disponibilite.HLE=19%3A00&assurance.selected=true&raison=sale&proforma_1.value=100&proforma_1.number=1&proforma_1.poids=2.42&proforma_1.origine=FR&proforma_1.description_en=Newspapers&proforma_1.description_fr=Journaux&platform=library&platform_version=2.0.1

 

#8 Comment effectuer une cotation sur un point relais (operateur/service) précis?

Lors de la cotation, ajoutez les paramètres operator et service.

Exemple pour l'offre CpourToi de Mondial Relay:

operator=MONR&service=CpourToi

Lors du passage de la commande précisez le code du point relais (de dépôt et du destinataire).

depot.pointrelais=MONR-01744
ou
retrait.pointrelais=MONR-01744