FAQ API v1 Boxtal

• Comment ça marche l'api v1 Boxtal?
• Comment tester le passage de commande ?
• Y a t'il moyen de supprimer une commande à partir de la boutique e-commerce ?
• Comment afficher les points relais en fonction des transporteur ?
• 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 effectuer une cotation pour une offre de transport (operateur/service) précis?
• Traductions acceptées pour les paramètres

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 ou pli 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.
2. passage de commande (api/v1/order) pour le même colis ou pli et mêmes adresses en précisant le transporteur et l'offre de service, en général, en fonction du choix que le client final a fait sur le site. Vous devez ajouter un paramètre url_push pour être notifié des statuts de suivi (cf étape 3)
3. mise à jour du suivi: à chaque fois que le transporteur envoie une mise à jour du statut de suivi, Boxtal l'envoie sur l'url_push passé en paramètre lors du passage de commande. Vous pouvez afficher ou pas ces informations dans le back-office et les mettre à disposition du client final.

Comment tester le passage de commande ?

Pour tester le passage de commande utilisez environnement de test qui pointe vers  https://test.envoimoinscher.com.

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. 

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

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

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 .

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

Je n'arrive pas à passer commande [access_denied]

1. 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

 

Comment effectuer une cotation pour une offre de trnasport (operateur/service) précise?

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

 

Traductions acceptées pour le paramètres 

Catégorie	Paramètre en FR	Paramètre en EN
Contact	destinataire	recipient
	expediteur	shipper
	pays	country
	codepostal code_postal	zipcode
	ville	city
	societe	pas de traduction
	type	pas de traduction
	adresse	address
	civilite	title
	prenom	firstname
	nom	lastname
	email	pas de traduction
	tel	phone
	tel2	phone2
	details	infos
Assurance	assurance.selection	insurance.selected
	assurance.emballage	pas de traduction
	assurance.materiau	pas de traduction
	assurance.protection	pas de traduction
	assurance.fermeture	pas de traduction
Colis	poids	weight
	longueur	length
	largeur	width
	hauteur	height
	code_contenu	content_code
	type_emballage.emballage	packaging_type.emballage
Proforma	nombre	number
	valeur	value
	poids	weight
	origine	pas de traduction
	raison	reason
Autres filtres de cotation	operateur	operator
	service	pas de traduction
	prix_max_ttc	max_tax_inclusive_price
	prix_max_ht	max_tax_exclusive_price
	prix_exact_ttc	exact_tax_inclusive_price
	prix_exact_ht	exact_tax_exclusive_price
	delai	delay
	collecte	collection_date
Pour tous les autres paramètres ou filtres, pas de traduction en EN