Remarques générales
Cotations
Commandes
URL de push
Liste des points relais
Contenus
Dictionnaire des pays
Traduction des paramètres
PROTOCOLE
Le protocole à utiliser pour tous les appels à l’API est https.
ENCODAGE
Les URIs d’appel à l’API v1 sont construites d’après le modèle suivant :
https://www.envoimoinscher.com/api/v1/[/][.../chemin/.../]/ressource
La langue par défaut est « fr », c’est la seule langue disponible à l’heure actuelle. C’est la langue des noms de paramètres à fournir dans les requêtes et des libellés des réponses. Par contre, les noms des ressources et les balises des documents XML de réponse sont toujours en anglais. Se référer à la section "Traduction des paramètres" pour une correspondance entre les noms français des paramètres et les balises en anglais associées.
L’URI doit être en minuscules.
FORMATS DES URLS ET REQUÊTES
Les requêtes sont à réaliser en :
- GET (pour une consultation de ressource, une cotation),
- POST (pour une commande).
Les paramètres sont à fournir :
- dans le chemin de l’URI pour les requêtes GET de type ‘dictionnaire’,
- avec une chaîne de requête (« query string ») spécifiant la valeur de chacun d’eux pour les requêtes GET ou POST de cotation ou de prise de commande.
FORMATS DES RÉPONSES
Toutes les réponses sont au format XML, sans attributs.
CODES DE RETOUR
Le code de retour HTTP peut être :
- 200 : succès,
- 400 : requête invalide,
- 401 : accès interdit,
- 404 : ressource non trouvée,
- 500 : erreur interne du serveur.
En cas d’erreur, le corps de la réponse est un document XML structuré comme suit :
<error>
<code>code de l'erreur</code>
<message>message associé</message>
</error>
AUTHENTIFICATION
Pour chaque requête API il faut utiliser la même authentification de type Basic Auth en passant les paramètres suivants :
- username = votre_identifiant,
- password = votre_mot_de_passe,
NB : la clé api (header access_key) qui était autrefois requise a été dépréciée. Elle est désormais ignorée si vous l'envoyez.
Exemple :
curl --request GET \
--url http://www.envoimoinscher.com/api/v1/contents \
--header 'Authorization: Basic b3RpbGlhLmNhbGluZXNjdUBnbWFpbC5jb206dG90b3RvdG8='
ENVIRONNEMENTS DE TEST ET DE PRODUCTION
L’api est disponible dans 2 environnements :
- de test : https://test.envoimoinscher.com
- de production : https://www.envoimoinscher.com/
Pour utiliser l'API en mode test, vous devez vous créer un compte sur notre environnement de test, et utiliser l'identifiant et le mot de passe du compte ainsi créé, conjugués à l'URL de test ci-dessus.
Les commandes passées en environnement de test ne sont pas facturées, celles passées en production si.
PARAMÈTRES
Dans la réponse de cotation vous pouvez obtenir les éléments qui contiennent les informations facultatives à fournir, entre autres, pour les options. Chaque noeud est composé du code, libellé et type. Ce dernier détermine quel type de données est attendu par l’API. Les types possibles retournés dans la réponse sont :
- string – une chaîne de caractères,
- float – un nombre en virgule flotante,
- boolean – true ou false,
- enum – une liste de valeurs, qui peuvent être des identifiants renvoyant à un dictionnaire de données.
GET/API/V1/COTATION
Une cotation concerne un envoi d’un ou plusieurs colis, par un expéditeur pour un destinataire.
Le pays d’expédition et/ou le pays de destination doit être la France.
Les paramètres à fournir sont hiérarchisés, avec le point (« . ») comme séparateur de niveau.
Par exemple : destinataire.societe correspond au nom de la société du destinataire
PARAMÈTRES
N : numéro de colis dans le cas ou l’envoi se fait en plusieurs colis (1,2,3,…)
| Paramètre | Obligatoire / Optionnel | Remarques |
|---|---|---|
| colis_N.poids | Obligatoire | Poids du colis N exprimé en kg |
| colis_N.longueur | Obligatoire | Longueur du colis N exprimée en cm |
| colis_N.largeur | Obligatoire | Largeur du colis N exprimée en cm |
| colis_N.hauteur | Obligatoire | Hauteur du colis N exprimée en cm |
| code_contenu | Obligatoire | Code à 5 chiffres correspondant au contenu de votre envoi (voir rubrique "Contenus") |
| expediteur.pays | Obligatoire | Code iso du pays (voir rubrique "Dictionnaire des pays") |
| expediteur.code_postal | Obligatoire | Si le pays n'a pas de code postal, le paramètre est optionnel. |
| expediteur.ville | Obligatoire | |
| expediteur.type | Obligatoire | "particulier" ou "entreprise" |
| destinataire.pays | Obligatoire | Code iso du pays (voir rubrique "Dictionnaire des pays") |
| destinataire.code_postal | Obligatoire | Si le pays n'a pas de code postal, le paramètre est optionnel. |
| destinataire.ville | Obligatoire | |
| destinataire.type | Obligatoire | "particulier" ou "entreprise" |
| collecte | Optionnel | Date de collecte souhaitée au format YYYY-MM-DD. Si le paramètre est absent, la valeur est mise à la date du jour. |
| operator | Optionnel | Code transporteur sur 4 caractères : CHRP : Chronopost, COPR : Colis Privé, DLVG : Delivengo, DHLE : DHL, FEDX : Fedex, IMXE : Happy Post, MONR : Mondial Relay, POFR : Colissimo, SOGP : Relais Colis, TNTE : TNT, UPSE : UPS |
| service | Optionnel | Code de l’offre de service du transporteur |
| assurance | Optionnel | Si présent, la valeur valide est "true" et le résultat de la cotation contient le prix de l’assurance de l’envoi. Le paramètre colis.valeur doit également être rempli. |
| colis.valeur | Optionnel | Valeur de la marchandise contenue dans le colis. en cas de multi-colis, le paramètre correspond à la somme des valeurs de chaque colis. Obligatoire pour avoir le prix de l’assurance de l’envoi, le paramètre assurance doit également être présent. |
| offers[] | Optionnel | Paramètre qui permet de lancer une cotation en ciblant plusieurs offres de plusieurs transporteurs. Exemple de cotation avec les transporteurs Chronopost et Mondial Relay et leurs services respectifs ChronoShoptoShop et CpourToi : "offers[0]=CHRPChronoShoptoShop&offers[1]=MONRCpourToi" Dans le cas où le paramètre offers est utilisé, les paramètres operator et service doivent être vides ou absents. |
RÉPONSE
La réponse à une demande de cotation contient les offres de transport éligibles et valides pour l’envoi demandé.
Modalités de dépôt du colis :
- POST_OFFICE : dépôt en bureau de poste,
- DROPOFF_POINT : dépôt en point relais,
- HOME : enlèvement à domicile,
- COMPANY : enlèvement en entreprise.
Modalités de livraison d’une offre :
- PICKUP_POINT : retrait en point relais,
- HOME : livraison à domicile,
- COMPANY : livraison en entreprise.
La date de la livraison est estimée par Boxtal par rapport à la date de collecte (paramètre collecte) et restituée dans le champ delivery.date.
Le prix de l’assurance est indiqué dans la réponse si :
- le paramètre assurance=true est présent dans la cotation,
- le paramètre colis.valeur est renseigné,
- le type de la marchandise est couvert par l'assureur,
- le pays d'expédition ou de destination de l'envoi est couvert par l’assureur.
DTD SIMPLIFIÉE DE LA RÉPONSE
cotation
shipment
package*
weight
length
width
height
quantity
content
collection_date
delay
description
shipper
type
country
zipcode
city
recipient
type
country
zipcode
city
offer*
mode
url
operator
code
label
logo
service
code
label
price
currency
tax-inclusive
tax-exclusive
collection
type
code
label
date
time
label
delivery
type
code
label
date
time | delay
label
alert*
characteristics
label*
mandatory_informations?
parameter*
code
label
type
boolean
|string
|float
|enum
value+
insurance?
currency
tax-inclusive
tax-exclusive
options?
option
code
label
parameter+
code label
type
boolean
|string
|float
|enum
value+
price
currency
tax-inclusive
tax-exclusive
Exemple :
GET/api/v1/cotation expediteur.pays=FR&expediteur.code_postal=44000&expediteur.ville=Nantes&expediteur.type=particulier& expediteur.adresse= 1% 2C+rue+Racine&destinataire.pays=FR&destinataire.code_postal=75002&destinataire.ville=Paris&destinataire.type= particulier&destinataire.adresse=1% 2C+rue+du+Grand+Lebrun&colis_1.poids=3&colis_1.longueur=7&colis_1.largeur=8& colis_1.hauteur=11&colis_2.poids=3&colis_2.longueur=7&colis_2.largeur=8&colis_2.hauteur=11&collecte=2011-08-24& delai=aucun&code_contenu=10120
Réponse :
<?xml version='1.0' encoding='UTF-8'?>
<cotation>
<shipment>
<package>
<weight>6.0</weight>
<length>20</length>
<width>20</width>
<height>25</height>
<quantity>1</quantity>
</package>
<content>10120</content>
<collection_date>2022-03-20</collection_date>
<delay>aucun</delay>
<shipper>
<type>entreprise</type>
<country>FR</country>
<zipcode>51684</zipcode>
<city>Reims</city>
</shipper>
<recipient>
<type>particulier</type>
<country>FR</country>
<zipcode>51430</zipcode>
<city>bezannes</city>
</recipient>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp-chronoshoptoshop.png</logo>
</operator>
<service>
<code>ChronoShoptoShop</code>
<label>Chrono Shop2Shop</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>7.98</tax-exclusive>
<tax-inclusive>9.58</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Vous devez déposer votre envoi dans un Relais Pickup de votre choix le 21/03/2022</label>
<label>Mise à disposition en Relais Pickup à partir du 25/03/2022 avant 15h. L'envoi reste à disposition pendant 8 jours.</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 460€ par colis.</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>depot.pointrelais</code>
<label>Choix du point relais de départ</label>
<type>
<enum>
<value>CHRP-4016V</value>
<value>CHRP-3548S</value>
<value>CHRP-5405V</value>
<value>CHRP-0339X</value>
<value>CHRP-5652U</value>
<value>CHRP-0349U</value>
<value>CHRP-8617U</value>
<value>CHRP-7419U</value>
<value>CHRP-2074U</value>
<value>CHRP-6238S</value>
</enum>
</type>
</parameter>
<parameter>
<code>retrait.pointrelais</code>
<label>Choix du point relais d'arrivée</label>
<type>
<enum>
<value>CHRP-4961V</value>
<value>CHRP-7986U</value>
<value>CHRP-0455V</value>
<value>CHRP-7513U</value>
<value>CHRP-5797R</value>
<value>CHRP-4492P</value>
<value>CHRP-7133U</value>
<value>CHRP-8622U</value>
<value>CHRP-3950P</value>
<value>CHRP-1275S</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>DROPOFF_POINT</code>
<label>dépôt en point relais</label>
</type>
<date>2022-03-21</date>
<label>Vous devez déposer votre envoi dans un Relais Pickup de votre choix le 21/03/2022</label>
</collection>
<delivery>
<type>
<code>PICKUP_POINT</code>
<label>retrait en point relais</label>
</type>
<date>2022-03-25</date>
<label>Mise à disposition en Relais Pickup à partir du 25/03/2022 avant 15h. L'envoi reste à disposition pendant 8 jours.</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>ChronoRelais</code>
<label>Chrono Relais</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>10.41</tax-exclusive>
<tax-inclusive>12.49</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 21/03/2022</label>
<label>Mise à disposition en Chrono Relais® à partir du 22/03/2022 avant 15h. L'envoi reste à disposition pendant 8 jours.</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, déterioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>depot.pointrelais</code>
<label>Choix du point relais de départ</label>
<type>
<enum>
<value>CHRP-POST</value>
</enum>
</type>
</parameter>
<parameter>
<code>retrait.pointrelais</code>
<label>Choix du point relais d'arrivée</label>
<type>
<enum>
<value>CHRP-4961V</value>
<value>CHRP-7986U</value>
<value>CHRP-0455V</value>
<value>CHRP-7513U</value>
<value>CHRP-5797R</value>
<value>CHRP-4492P</value>
<value>CHRP-7133U</value>
<value>CHRP-8622U</value>
<value>CHRP-3950P</value>
<value>CHRP-1275S</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>POST_OFFICE</code>
<label>dépôt en point relais</label>
</type>
<date>2022-03-21</date>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 21/03/2022</label>
</collection>
<delivery>
<type>
<code>PICKUP_POINT</code>
<label>retrait en point relais</label>
</type>
<date>2022-03-22</date>
<label>Mise à disposition en Chrono Relais® à partir du 22/03/2022 avant 15h. L'envoi reste à disposition pendant 8 jours.</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>Chrono18</code>
<label>Chrono18</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>12.53</tax-exclusive>
<tax-inclusive>15.03</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 21/03/2022</label>
<label>Livraison à l'adresse du destinataire le 22/03/2022 avant 18:00</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
<label>En cas d'impossibilité de livraison, votre envoi est mis en instance dans un bureau de Poste de votre choix à proximité</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>depot.pointrelais</code>
<label>Choix du point relais de départ</label>
<type>
<enum>
<value>CHRP-POST</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>POST_OFFICE</code>
<label>dépôt en point relais</label>
</type>
<date>2022-03-21</date>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 21/03/2022</label>
</collection>
<delivery>
<type>
<code>HOME</code>
<label>livraison à domicile</label>
</type>
<date>2022-03-22</date>
<time>18:00</time>
<label>Livraison à l'adresse du destinataire le 22/03/2022 avant 18:00</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>Chrono13</code>
<label>Chrono13</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>17.24</tax-exclusive>
<tax-inclusive>20.69</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 21/03/2022</label>
<label>Livraison à l'adresse du destinataire le 22/03/2022 avant 13:00</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
<label>En cas d'impossibilité de livraison, votre envoi est mis en instance dans un bureau de Poste de votre choix à proximité</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>depot.pointrelais</code>
<label>Choix du point relais de départ</label>
<type>
<enum>
<value>CHRP-POST</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>POST_OFFICE</code>
<label>dépôt en point relais</label>
</type>
<date>2022-03-21</date>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 21/03/2022</label>
</collection>
<delivery>
<type>
<code>HOME</code>
<label>livraison à domicile</label>
</type>
<date>2022-03-22</date>
<time>13:00</time>
<label>Livraison à l'adresse du destinataire le 22/03/2022 avant 13:00</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>Chrono18</code>
<label>Chrono18</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>17.37</tax-exclusive>
<tax-inclusive>20.84</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 25/03/2022</label>
<label>Livraison à l'adresse du destinataire le 26/03/2022 avant 18:00</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
<label>En cas d'impossibilité de livraison, votre envoi est mis en instance dans un bureau de Poste de votre choix à proximité</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>depot.pointrelais</code>
<label>Choix du point relais de départ</label>
<type>
<enum>
<value>CHRP-POST</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
<option>
<code>saturdaydelivery</code>
<name>Supplément pour livraison le samedi</name>
<parameter>
<code>saturdaydelivery.selection</code>
<label>paramètre de sélection de l'option : Supplément pour livraison le samedi.</label>
<type>
<boolean/>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>POST_OFFICE</code>
<label>dépôt en point relais</label>
</type>
<date>2022-03-25</date>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 25/03/2022</label>
</collection>
<delivery>
<type>
<code>HOME</code>
<label>livraison à domicile</label>
</type>
<date>2022-03-26</date>
<time>18:00</time>
<label>Livraison à l'adresse du destinataire le 26/03/2022 avant 18:00</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>ChronoRelaisPickup</code>
<label>Chrono Relais</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>18.33</tax-exclusive>
<tax-inclusive>22.0</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Enlèvement à l'adresse de l'expéditeur le 21/03/2022 entre 13:00 et 18:00</label>
<label>Supplément pour enlèvement</label>
<label>Mise à disposition en Chrono Relais® à partir du 22/03/2022 avant 15h. L'envoi reste à disposition pendant 8 jours.</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>retrait.pointrelais</code>
<label>Choix du point relais d'arrivée</label>
<type>
<enum>
<value>CHRP-4961V</value>
<value>CHRP-7986U</value>
<value>CHRP-0455V</value>
<value>CHRP-7513U</value>
<value>CHRP-5797R</value>
<value>CHRP-4492P</value>
<value>CHRP-7133U</value>
<value>CHRP-8622U</value>
<value>CHRP-3950P</value>
<value>CHRP-1275S</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>COMPANY</code>
<label>enl`vement en entreprise</label>
</type>
<date>2022-03-21</date>
<label>Enlèvement à l'adresse de l'expéditeur le 21/03/2022 entre 13:00 et 18:00</label>
</collection>
<delivery>
<type>
<code>PICKUP_POINT</code>
<label>retrait en point relais</label>
</type>
<date>2022-03-22</date>
<label>Mise à disposition en Chrono Relais® à partir du 22/03/2022 avant 15h. L'envoi reste à disposition pendant 8 jours.</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>Chrono18Pickup</code>
<label>Chrono18</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>20.11</tax-exclusive>
<tax-inclusive>24.13</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Enlèvement à l'adresse de l'expéditeur le 21/03/2022 entre 09:00 et 19:00</label>
<label>Supplément pour enlèvement</label>
<label>Livraison à l'adresse du destinataire le 22/03/2022 avant 18:00</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, déterioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
<label>En cas d'impossibilité de livraison, votre envoi est mis en instance dans un bureau de Poste de votre choix à proximité</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>COMPANY</code>
<label>enl`vement en entreprise</label>
</type>
<date>2022-03-21</date>
<label>Enlèvement à l'adresse de l'expéditeur le 21/03/2022 entre 09:00 et 19:00</label>
</collection>
<delivery>
<type>
<code>HOME</code>
<label>livraison à domicile</label>
</type>
<date>2022-03-22</date>
<time>18:00</time>
<label>Livraison à l'adresse du destinataire le 22/03/2022 avant 18:00</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>Chrono13Samedi</code>
<label>Chrono13Samedi</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>22.44</tax-exclusive>
<tax-inclusive>26.93</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 25/03/2022</label>
<label>Livraison à l'adresse du destinataire le 26/03/2022 avant 13:00</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
<label>En cas d'impossibilité de livraison, votre envoi est mis en instance dans un bureau de Poste de votre choix à proximité</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>depot.pointrelais</code>
<label>Choix du point relais de départ</label>
<type>
<enum>
<value>CHRP-POST</value>
</enum>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
<option>
<code>saturdaydelivery</code>
<name>Supplément pour livraison le samedi</name>
<parameter>
<code>saturdaydelivery.selection</code>
<label>paramètre de sélection de l'option : Supplément pour livraison le samedi.</label>
<type>
<boolean/>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>POST_OFFICE</code>
<label>dépôt en point relais</label>
</type>
<date>2022-03-25</date>
<label>Vous devez déposer votre envoi dans un bureau de Poste de votre choix le 25/03/2022</label>
</collection>
<delivery>
<type>
<code>HOME</code>
<label>livraison à domicile</label>
</type>
<date>2022-03-26</date>
<time>13:00</time>
<label>Livraison à l'adresse du destinataire le 26/03/2022 avant 13:00</label>
</delivery>
</offer>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>CHRP</code>
<label>Chronopost</label>
<logo>https://resource.boxtal.com/images/carriers/chrp.png</logo>
</operator>
<service>
<code>Chrono18Pickup</code>
<label>Chrono18</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>25.02</tax-exclusive>
<tax-inclusive>30.02</tax-inclusive>
</price>
<alert></alert>
<characteristics>
<label>Enlèvement à l'adresse de l'expéditeur le 25/03/2022 entre 09:00 et 19:00</label>
<label>Supplément pour enlèvement</label>
<label>Livraison à l'adresse du destinataire le 26/03/2022 avant 18:00</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Suivi en ligne possible</label>
<label>Assurance contractuelle en cas de perte, déterioration ou spoliation de votre envoi ; s'élève à une indemnité de 23€ par kg sans pouvoir excéder 690€ par colis.</label>
<label>En cas d'impossibilité de livraison, votre envoi est mis en instance dans un bureau de Poste de votre choix à proximité</label>
</characteristics>
<mandatory_informations>
<parameter>
<code>colis.description</code>
<label>description du contenu de l'envoi</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>colis.valeur</code>
<label>valeur déclarée du contenu de l'envoi</label>
<type>
<float/>
</type>
</parameter>
<parameter>
<code>expediteur.civilite</code>
<label>civilite de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.nom</code>
<label>nom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.prenom</code>
<label>prenom de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.adresse</code>
<label>adresse de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>expediteur.email</code>
<label>email de l'expéditeur</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.civilite</code>
<label>civilite du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.nom</code>
<label>nom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.prenom</code>
<label>prenom du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.adresse</code>
<label>adresse du destinataire</label>
<type>
<string/>
</type>
</parameter>
<parameter>
<code>destinataire.email</code>
<label>email du destinataire</label>
<type>
<string/>
</type>
</parameter>
</mandatory_informations>
<options>
<option>
<code>assurance</code>
<name>Assurance transport</name>
<parameter>
<code>assurance.selection</code>
<label>paramètre de sélection de l'option : assurance transport</label>
<type>
<boolean/>
</type>
</parameter>
<parameter>
<code>assurance.emballage</code>
<label>type d'emballage utilisé</label>
<type>
<enum>
<value>Boîte</value>
<value>Caisse</value>
<value>Bac</value>
<value>Emballage isotherme</value>
<value>Etui</value>
<value>Malle</value>
<value>Sac</value>
<value>Tube</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.materiau</code>
<label>Matériau utilisé</label>
<type>
<enum>
<value>Carton</value>
<value>Bois</value>
<value>Carton blindé</value>
<value>Film opaque</value>
<value>Film Transparent</value>
<value>Métal</value>
<value>Papier</value>
<value>Papier armé</value>
<value>Plastique et carton</value>
<value>Plastique</value>
<value>Plastique opaque</value>
<value>Plastique transparent</value>
<value>Polystyrène</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.protection</code>
<label>Protection intérieure utilisée</label>
<type>
<enum>
<value>Sans protection particulière</value>
<value>Calage papier</value>
<value>Bulles plastiques</value>
<value>Carton antichoc</value>
<value>Coussin air</value>
<value>Coussin mousse</value>
<value>Manchon carton (bouteille)</value>
<value>Manchon mousse (bouteille)</value>
<value>Matelassage</value>
<value>Plaque mousse</value>
<value>Polystyrène</value>
<value>Coussin de calage</value>
<value>Sachet bulles</value>
</enum>
</type>
</parameter>
<parameter>
<code>assurance.fermeture</code>
<label>Fermeture utilisée</label>
<type>
<enum>
<value>Fermeture autocollante</value>
<value>Ruban adhésif</value>
<value>Agrafes</value>
<value>Clous</value>
<value>Collage</value>
<value>Ruban de cerclage</value>
<value>Sangle ou feuillard</value>
<value>Agraphes et cerclage</value>
<value>Clous et cerclage</value>
<value>Ficelles</value>
</enum>
</type>
</parameter>
</option>
<option>
<code>saturdaydelivery</code>
<name>Supplément pour livraison le samedi</name>
<parameter>
<code>saturdaydelivery.selection</code>
<label>paramètre de sélection de l'option : Supplément pour livraison le samedi.</label>
<type>
<boolean/>
</type>
</parameter>
</option>
</options>
<collection>
<type>
<code>COMPANY</code>
<label>enl`vement en entreprise</label>
</type>
<date>2022-03-25</date>
<label>Enlèvement à l'adresse de l'expéditeur le 25/03/2022 entre 09:00 et 19:00</label>
</collection>
<delivery>
<type>
<code>HOME</code>
<label>livraison à domicile</label>
</type>
<date>2022-03-26</date>
<time>18:00</time>
<label>Livraison à l'adresse du destinataire le 26/03/2022 avant 18:00</label>
</delivery>
</offer>
</shipment>
</cotation>
POST/API/V1/ORDER
Le passage de commande concerne un envoi qui peut inclure un ou plusieurs colis.
Le pays d’expédition et/ou le pays de destination doit être la France.
Les paramètres à fournir sont hiérarchisés, avec le point (« . ») comme séparateur de niveau.
Par exemple, destinataire.societe correspond au nom de la société du destinataire.
Le compte facturé est le compte authentifié par username et password (voir la partie "Authentification" dans la section "Remarques générales").
Ce compte doit être en mode de paiement différé par prélèvement (pour plus d’informations sur ce mode de paiement, consultez l’article Tout savoir sur le paiement différé).
PARAMÈTRES
N : numéro de colis dans le cas ou l’envoi se fait en plusieurs colis (1,2,3,…)
| Paramètre | Optionnel / Obligatoire | Remarques |
|---|---|---|
| colis_N.poids | Obligatoire | Poids du colis N exprimé en kg |
| colis_N.longueur | Obligatoire | Longueur du colis N exprimée en cm |
| colis_N.largeur | Obligatoire | Largeur du colis N exprimée en cm |
| colis_N.hauteur | Obligatoire | Hauteur du colis N exprimée en cm |
| code_contenu | Obligatoire | Code à 5 chiffres correspondant au contenu de votre envoi (voir rubrique "Contenus") |
| expediteur.pays | Obligatoire | Code iso du pays (voir rubrique "Dictionnaire des pays") |
| expediteur.code_postal | Obligatoire | Si le pays n’a pas de codes postal, le paramètre est optionnel |
| expediteur.type | Obligatoire | "particulier" ou "entreprise" |
| expediteur.adresse | Obligatoire | |
| expediteur.nom | Obligatoire | |
| expediteur.prenom | Obligatoire | |
| expediteur.titre | Optionnel | Valeurs possibles : "Mme" ou "M" |
| expediteur.societe | Optionnel* | Obligatoire si : expediteur.type="entreprise" |
| expediteur.email | Obligatoire | |
| expediteur.tel | Obligatoire | |
| destinataire.pays | Obligatoire | Code iso du pays (voir rubrique "Dictionnaire des pays") |
| destinataire.code_postal | Obligatoire | Si le pays n’a pas de codes postal, le paramètre est optionnel |
| destinataire.type | Obligatoire | "particulier" ou "entreprise" |
| destinataire.adresse | Obligatoire | |
| destinataire.nom | Obligatoire | |
| destinataire.prenom | Obligatoire | |
| destinataire.societe | Optionnel | Obligatoire si : destinataire.type="entreprise" |
| destinataire.email | Obligatoire | |
| destinataire.tel | Obligatoire | |
| collecte | Optionnel | Date de collecte souhaitée au format YYYY-MM-DD. Un chauffeur se présentera à l’adresse de l’expéditeur à cette date. Si le paramètre est absent, la valeur est mise à la date du jour. |
| colis.description | Obligatoire | Description détaillé du contenu du colis. Informations indispensables pour le traitement de dossiers en cas de dommage ou de perte. |
| operator | Obligatoire | Code transporteur sur 4 caractères : CHRP : Chronopost, COPR : Colis Privé, DLVG : Delivengo, DHLE : DHL, FEDX : Fedex, IMXE : Happy Post, MONR : Mondial Relay, POFR : Colissimo, SOGP : Relais Colis, TNTE : TNT, UPSE : UPS |
| service | Obligatoire | Code du service retourné par la cotation |
| url_push | Obligatoire | Url unique par commande (voir section "URL de push") |
| depot.pointrelais | Optionnel | Pour les commandes avec dépôt en relais, code du point relais de dépôt (voir section "Liste des points relais") |
| retrait.pointrelais | Optionnel | Pour les commandes avec dépôt en relais, code du point relais de dépôt (voir section "Liste des points relais") |
| reference_externe | Optionnel | La référence de votre commande |
| assurance.selection | Optionnel | "true" ou "false", "0" ou "1". La souscription à l’assurance est soumise à une validation. |
| colis.valeur | Optionnel | Obligatoire si envoi à l’international ou si : assurance.selection="true" |
COMMANDES À L'INTERNATIONAL
Pour les envois qui passent par un service de douane, les paramètres ci-dessous sont aussi obligatoires.
X : numéro de l’article contenu dans votre envoi (1,2,3,…)
| Paramètre | Remarques |
|---|---|
| raison | Raison de l'envoi Valeurs valides : - sale : pour une vente, - repr : pour une réparation, - rtrn : pour un retour, - gift : pour un cadeau ou un don, smpl : pour un échantillon ou une maquette, - prsu : pour un usage personnel, icdt : pour les documents inter-entreprises, - othr : pour une autre raison. Une facture proforma sera automatiquement générée. |
| proforma_X.description_en | La description du produit envoyé en anglais |
| proforma_X.description_fr | La description du produit envoyé en français |
| proforma_X.nombre | La quantité de produit expédiée |
| proforma_X.valeur | La valeur unitaire du produit expédiée |
| proforma_X.origine | Code du pays d’origine du produit envoyé (voir la section "Dictionnaire des pays") |
| proforma_poids | Le poids unitaire du produit envoyé exprimé en kg |
La somme des poids des articles doit être égale au poids déclaré du ou des colis.
La somme des valeurs des articles doit être égale à la valeur déclaré du ou des colis.
RÉPONSE
La réponse à un passage de commande reprend les informations passées en paramètre et retourne la référence Boxtal de l’envoi, les caractéristiques de l’offre et les prix HT et TTC.
Parmi les caractéristiques de l’offre sélectionnée, il y a la modalité de dépôt ou d’enlèvement du colis dans les paramètres collection ainsi que celle de livraison dans le paramètre delivery.
Modalités de dépôt du colis :
- POST_OFFICE : dépôt en bureau de poste,
- DROPOFF_POINT : dépôt en point relai,
- HOME : enlèvement à domicile,
- COMPANY : enlèvement en entreprise.
Modalités de livraison d'une offre :
- PICKUP_POINT : retrait en point relai,
- HOME : livraison à domicile,
- COMPANY : livraison en entreprise.
La date de la livraison est estimée par Boxtal par rapport à la date de la collecte (paramètre collecte) et restituée dans le champ delivery.date.
DTD SIMPLIFIÉE DE LA RÉPONSE
order
shipment
package
weight
length
width
height
quantity
content
collection_date
delay
description
shipper
type
country
zipcode
city
address
company?
title
firstname
lastname
email
phone
recipient
type
country
zipcode
city
address
company?
title
firstname
lastname
email
phone
offer
mode
url
operator
code
label
logo
service
code
label
price
currency
tax-inclusive
tax-exclusive
detail
line+
label
currency
tax-inclusive
tax-exclusive
collection
type
code
label
date
time
label
delivery
type
date
time?
delay
label
characteristics
label*
Exemple :
POST /api/v1/order?expediteur.pays=FR&expediteur.code_postal=31400&expediteur.type=entreprise&expediteur.ville=Toulouse&expediteur.adresse=15 rue Marsollier&expediteur.civilite=M&expediteur.prenom=Jon&expediteur.nom=Snow&expediteur.email=jsnow%40test.com&expediteur.tel=0561070000&expediteur.societe=Boxtal&destinataire.pays=US&destinataire.etat=ND&destinataire.code_postal=58103&destinataire.type=particulier&destinataire.ville=Fargo&destinataire.adresse=123 W 43rd St&destinataire.civilite=Mme&destinataire.prenom=Jane&destinataire.nom=Doe&destinataire.email=jdoe%40test.com&destinataire.tel=%2B17015130514&colis_1.poids=0.9&colis_1.longueur=5&colis_1.largeur=5&colis_1.hauteur=5&colis.valeur=30.0&collecte=2022-04-19&delai=aucun&code_contenu=30100&operateur=DHLE&service=ExpressWorldwide&assurance.selected=1&raison=sale&proforma_1.description_en=L'Equipe newspaper from 1998&proforma_1.description_fr=L'Equipe magazine de 1998&proforma_1.number=1&proforma_1.value=10.0&proforma_1.origine=FR&proforma_1.poids=0.5&proforma_2.description_en=L'Equipe newspaper from 2000&proforma_2.description_fr=L'Equipe magazine de 2000&proforma_2.number=2&proforma_2.value=10&proforma_2.origine=FR&proforma_2.poids=0.2
Réponse :
<?xml version='1.0' encoding='UTF-8'?>
<order>
<shipment>
<reference>2011128770DHLE47HGUS</reference>
<package>
<weight>0.9</weight>
<length>5</length>
<width>5</width>
<height>5</height>
<quantity>1</quantity>
</package>
<content>30100</content>
<collection_date>2022-04-19</collection_date>
<delay>aucun</delay>
<shipper>
<type>entreprise</type>
<country>FR</country>
<zipcode>31400</zipcode>
<city>Toulouse</city>
</shipper>
<recipient>
<type>particulier</type>
<country>US</country>
<zipcode>58103</zipcode>
<city>Fargo</city>
</recipient>
<labels>
<label>http://test.envoimoinscher.com/documents?type=bordereau&envoi=2011128770DHLE47HGUS</label>
</labels>
<offer>
<mode>COM</mode>
<url></url>
<operator>
<code>DHLE</code>
<label>DHL Express</label>
<logo>https://resource.boxtal.com/images/carriers/dhle.png</logo>
</operator>
<service>
<code>ExpressWorldwide</code>
<label>DHL Express Worldwide</label>
</service>
<price>
<currency>EUR</currency>
<tax-exclusive>45.25</tax-exclusive>
<tax-inclusive>45.25</tax-inclusive>
<detail>
<line>
<label>Prestation de transport, commande et traitement</label>
<currency>EUR</currency>
<tax-exclusive>44.5</tax-exclusive>
<tax-inclusive>44.5</tax-inclusive>
</line>
<line>
<label>Assurance pour la valeur déclarée de 30.0€</label>
<currency>EUR</currency>
<tax-exclusive>0.75</tax-exclusive>
<tax-inclusive>0.75</tax-inclusive>
</line>
</detail>
</price>
<collection>
<type>
<code>HOME</code>
</type>
<date>2022-04-19</date>
</collection>
<delivery>
<type>
<code>HOME</code>
</type>
<date>2022-04-28</date>
<time>23:59</time>
</delivery>
<alert></alert>
<characteristics>
<label>Enlèvement à l'adresse de l'expéditeur le 19/04/2022 entre 14:00 et 18:00</label>
<label>Livraison (indicative) au domicile du destinataire le 28/04/2022 avant 23:59</label>
<label>Délai non garanti</label>
<label>Livraison contre signature ou cachet commercial</label>
<label>Les taxes et droits de douane éventuels ne sont pas inclus dans le prix indiqué et sont payables par le destinataire contre échange de l'envoi</label>
<label>Assurance contractuelle en cas de perte, détérioration ou spoliation de votre envoi : indemnité de 23€ par kg sans pouvoir excéder 750€</label>
</characteristics>
<insurance>
<currency>EUR</currency>
<tax-exclusive>0.75</tax-exclusive>
<tax-inclusive>0.75</tax-inclusive>
</insurance>
</offer>
</shipment>
</order>
Pour être notifié de la mise à jour du suivi, vous devez passer en paramètre au moment du passage de la commande une url de push. Ce paramètre url_push fonctionne comme un webhook: à chaque mise à jour du suivi transporteur, un push est fait sur l'url indiquée avec des informations additionnelles.
La valeur de l'url de push passée en paramètre doit être unique pour chaque commande donc contenir l’id de la commande.
Exemple :
www.mon-site.com?orderId=XXXX
BORDEREAU DE TRANSPORT ET RÉFÉRENCE DU TRANSPORTEUR
Après le passage d’une commande et dès que le bordereau est disponible, un premier push est envoyé qui contient l'url pour télécharger les documents d’expédition.
La référence du transporteur n'est envoyée qu'à ce moment là.
Exemple :
www.mon-site.com?OrderID=xxxxxx&type=status&emc_reference=2109029325MONRxxxxxDE&carrier_reference=2356764&priceHT=7.51&priceTTC=7.51&dateCollecte=2021-09-13_00:00:00&Delivery=2021-09-21_00:00:00&label_url=https%3A%2F%2Fdocuments.envoimoinscher.com%2Fdocuments%3Ftype%3Dbordereau%26envoi%3D2109029325MONRxxxxxDE
La valeur "type=status" permet d'identifier qu'il s'agit d'un push initial après le passage de commande.
Paramètre additionnels envoyés :
| Paramètre additionnel | Définition |
|---|---|
| emc_reference | Référence Boxtal de la commande |
| carrier_reference | Référence du transporteur |
| label_url | Url pour télécharger le bordereau d'expédition Requête de type GET avec authentification (login, mot de passe) pour télécharger le pdf du document. |
| remise (optionnel) | Url du bordereau de remise Colissimo Requête de type GET avec authentification (login, mot de passe) pour télécharger le pdf du document. |
| manifest (optionnel) | Url du document de suivi TNT International Requête de type GET avec authentification (login, mot de passe) pour télécharger le pdf du document. |
| proforma (optionnel) | Url de la facture proforma pour les envois internationaux sans facture commerciale Requête de type GET avec authentification (login, mot de passe) pour télécharger le pdf du document. |
| b13a (optionnel) | Url de la déclaration d’exportation b13a pour l’export depuis le Canada Requête de type GET avec authentification (login, mot de passe) pour télécharger le pdf du document. |
MISE À JOUR DU SUIVI
À chaque fois que le transporteur met à jour le suivi du colis, un push est envoyé sur l’url_push avec les informations de localisation de l'envoi. Vous pouvez ou non afficher ces informations dans votre back-office ou encore les mettre à disposition des clients finaux.
Exemple :
www.mon-site.com?OrderID=xxxxxx&&type=tracking&text=Colis%20en%20cours%20d'acheminement&localisation=HUB%20CHRONOPOST%20ILE%20DE%20FRANCE&etat=ENV&date=2021-09-10T10:59&envoi=2109018099CHRPxxxxFR
La valeur "type=tracking" permet d'identifier qu'il s'agit d'un push de mise à jour de suivi.
Paramètre additionnels envoyés :
| Paramètre additionnel | Définition |
|---|---|
| text | Message du transporteur relatif au statut de l'envoi |
| localisation | Localisation géographique de l'envoi |
| etat | Statut qui donne l’état de la commande : - CMD : commande de transporte passée (l'envoi n'a pas encore été scanné par le transporteur), - ENV : envoi en cours d'acheminement (un ou plusieurs scans du transporteur sont déjà présents), - LIV : envoi livré, - ANL : commande annulée. |
| date | Date de mise à jour du statut de suivi |
| envoi | Référence Boxtal de la commande de transport |
GET/API/V1/LISTPOINTS
Liste des points relais ouverts pour une adresse donnée. Retourne 30 points relais par transporteur, géolocalisés autour de l’adresse si le paramètre « adresse » est renseigné.
| Paramètre | Optionnel / obligatoire | Remarques |
|---|---|---|
| collecte | optionnel | Valeurs possibles : “dest” ou “exp”. Par défaut “dest” |
| pays | obligatoire | |
| ville | obligatoire | |
| cp | obligatoire | Code postal |
| adresse | optionnel | |
| carriers[i] | optionnel | Array avec le(s) code(s) transporteur(s). Valeurs valides : MONR (Mondial Relay), CHRP (Chronopost), COPR (Colis Privé), SOGP (Relais Colis), UPSE (UPS Access Point). Si le paramètre est absent, la requête retourne 30 points relais par transporteur. Pour filtrer sur plusieurs transporteurs, il faut indiquer plusieurs fois le paramètre carriers. carriers[a] = MONR carriers[b] = CHRP Le nom de la variable entre crochet est arbitraire, tant qu'il diffère pour chaque transporteur. |
GET/API/V1/carrier_code/LISTPOINTS
Liste des points relais ouverts pour une adresse donnée et pour un transporteur donné. Retourne 30 points relais par transporteur, géolocalisés autour de l’adresse si le paramètre « adresse » est renseigné.
Les valeurs valides pour « carriers_code » : MONR (Mondial Relay), CHRP (Chronopost), COPR (Colis Privé), SOGP (Relais Colis) et UPSE (UPS Access Points).
| Paramètre | Optionnel / obligatoire | Remarques |
|---|---|---|
| collecte | optionnel | Valeurs possibles : “dest” ou “exp”. Par défaut “dest” |
| pays | obligatoire | |
| ville | obligatoire | |
| cp | obligatoire | Code postal |
| adresse | optionnel |
DTD SIMPLIFIÉE DE LA RÉPONSE
carriers
carrier*
operator
service
points
point*
code
name
address
city
zipcode
latitude
longitude
country
phone
description
schedule
day*
weekday
open_am
close_am
open_pm
close_pm
RÉPONSE
<carriers>
<carrier>
<operator>CHRP</operator>
<service></service>
<points>
<point>
<code>CHRP-0256X</code>
<name>Consigne Pickup Gare de l Est</name>
<address>1 PLACE DU 11 NOVEMBRE 1918, A l'interieur au niveau acces metro</address>
<city>PARIS</city>
<zipcode>75010</zipcode>
<country>FR</country>
<latitude>48.87693</latitude>
<longitude>2.35999</longitude>
<phone></phone>
<description></description>
<schedule>
<day>
<weekday>1</weekday>
<open_am>05:00</open_am>
<close_am>12:00</close_am>
<open_pm>12:00</open_pm>
<close_pm>23:59</close_pm>
</day>
<day>
<weekday>2</weekday>
<open_am>05:00</open_am>
<close_am>12:00</close_am>
<open_pm>12:00</open_pm>
<close_pm>23:59</close_pm>
</day>
...
</schedule
</point>
...
</points>
</carrier>
...
</carriers>
GET/API/V1/CONTENTS
Méthode qui retourne tous les contenus, valides ou invalides.
DTD SIMPLIFIÉE DE LA RÉPONSE :
contents
content*
code
label
category
RÉPONSE :
<?xml version="1.0" encoding="UTF-8"?>
<contents>
<content>
<code>10100</code>
<label>Documents sans valeur commerciale</label>
<category>10000</category>
<prohibited>false</prohibited>
<translations>
<translation>
<locale>it_IT</locale>
<label>Documenti privi di valore commerciale</label>
</translation>
<translation>
<locale>es_ES</locale>
<label>Documentos sin valor comercial</label>
</translation>
<translation>
<locale>fr_FR</locale>
<label>Documents sans valeur commerciale</label>
</translation>
<translation>
<locale>en_US</locale>
<label>Documents without commercial value</label>
</translation>
</translations>
</content>
....
</contents>
La valeur à utiliser dans la cotation et le passage de commande pour le paramètre « code_contenu » est celle qui se trouve contents -> content -> code (10100 dans l’exemple ci-dessus).
GET/API/V1/COUNTRIES
Liste de tous les pays.
DTD SIMPLIFIÉE DE LA RÉPONSE
countries
country*
code
label
RÉPONSE
<?xml version="1.0" encoding="UTF-8"?>
<countries>
<country>
<code>P1</code>
<label>ACORES (PORTUGAL)</label>
</country>
<country>
<code>AF</code>
<label>AFGHANISTAN</label>
</country>
...
</countries>
Les paramètres fournis peuvent être exprimés soit en français, soit en anglais.
Voici le dictionnaire des traductions :
| Paramètre en français | Paramètre en anglais |
|---|---|
| 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 |
| pas de traduction | |
| tel | phone |
| tel2 | phone2 |
| details | infos |
| assurance.selection | insurance.selected |
| assurance.emballage | pas de traduction |
| assurance.materiau | pas de traduction |
| assurance.protection | pas de traduction |
| assurance.fermeture | pas de traduction |
| poids | weight |
| longueur | length |
| largeur | width |
| hauteur | height |
| code_contenu | content_code |
| type_emballage.emballage | packaging_type.emballage |
| nombre | number |
| valeur | value |
| poids | weight |
| origine | pas de traduction |
| raison | reason |
| operateur | operator |
| service | pas de traduction |
| operateur | operator |
| 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 en français, il n’existe pas de traduction en anglais.