FAQ API v1 Boxtal

• Comment ça marche l'api v1 Boxtal?
  
• Y a t'il moyen de supprimer une commande à partir de la boutique e-commerce ?
  
• Quelle url donner à mon client pour le suivi de la commande ?
• Comment obtenir le numéro de suivi du transporteur ?
• Je n'arrive pas à passer commande [bad_request]
• Je n'arrive pas à passer commande [access_denied]
• Exemple de requête avec une proforma

Comment ça marche l'api v1 Boxtal?

 L'api V1 Boxtal fonctionne en 3 étapes:

1. demande de cotation (api/v1/cotation) pour un colis, depuis une adresse d'expédition vers une adresse de destination. Il est possible d'ajouter des filtres sur les transporteurs et leurs offres. En retour, vous avez les prix par transporteur et par offre de service. Libre à vous de laisser vos clients choisir en front leur mode de livraison et de leur restituer le prix Boxtal des bordereaux si vous le souhaitez.
2. passage de commande (api/v1/order) pour le même colis et mêmes adresses en précisant le transporteur et l'offre de service, en général, en fonction du choix que votre client a fait sur votre site. Vous devez ajouter un paramètre url_push pour être notifié des statuts de suivi (cf étape 3). Ce paramètre fonctionne comme un webhook.
3. mise à jour du suivi: à chaque fois que le transporteur nous envoie une mise à jour du statut du suivi, nous l'envoyons sur l'url_push passé en paramètre lors du passage de commande. Vous pouvez afficher ou pas ces informations dans votre back-office ou les mettre à disposition de votre client.

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. 

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. A vous de décider où et comment afficher le suivi pour le client final.

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

Comment obtenir le numéro de suivi du transporteur ?

Pour récupérer le numéro de suivi du transporteur il faut ajouter une url de push en paramètre lors du passage de la commande. Dès la génération du bordereau, vous recevrez un premier push qui contient la référence du transporteur.

Exemple : 

push request to https://secure.xxxxx.com?OrderID=xxxxxx&type=status&
emc_reference=2109029325MONRxxxxxDE&carrier_reference=26xxxxx24&
priceHT=7.51&priceTTC=9.99&dateCollecte=2021-09-13_00:00:00&
Delivery=2021-09-21_00:00:00&label_url=https%3A%2F%2Furl_telechargement_bordereau

Je n'arrive pas à passer commande [bad_request]

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ître la liste des opérateurs et des services lancez une cotation (voir section '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

Je n'arrive pas à passer commande [access_denied]

Votre commande dépasse le montant maximum autorisé pour le paiement différé

Vous avez dépassé le montant autorisé pour le paiement différé. Veuillez contacter le service comptable et demandez l'augmentation du plafond.

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

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