GET/api/v1/cotation

Une cotation concerne un envoi unique, constitué d’un objet (pli, colis, encombrant, palette) unique. Le pays d’expédition est pour l’instant restreint à la France. Les paramètres à fournir en GET sont hiérarchisés, avec le point (« . ») comme séparateur de niveau. Par exemple, package.weight correspond au poids du colis.

Paramètres

(type = ‘pli’, ‘colis’, ‘encombrant’, ‘palette’, N = numéro de colis (1, 2, 3…))

Paramètre Remarques
type_N.poids
type_N.longueur
type_N.largeur
type_N.hauteur sauf pour type: pli
code_contenu le contenu de votre envoi (identifiant récuperé à partir de la ressource Contenus et classification des contenus
type.valeur en euros, obligatoire pour certains opérateurs et certaines destinations, utilisé aussi
pour l’assurance valeur déclarée
expediteur.pays code iso
expediteur.code_postal sauf si pas de code postal pour le pays concerné
expediteur.type ‘particulier’ ou ‘entreprise’, pour une entreprise ou un particulier
destinataire.pays code iso
destinataire.code_postal sauf si pas de code postal pour le pays concerné
destinataire.type ‘particulier’ ou ‘entreprise’, pour une entreprise ou un particulier
collecte date de collecte souhaitée au format YYYY-MM-DD
délai ‘aucun’ => offres triées par prix décroissant, ‘minimum’ => offres triées par délai croissant,
‘course’ => seules les offres de course avec livraison dans la journée

Paramètres optionnels de filtrage des offres

Paramètre Remarques
opérateur code de l’opérateur à séléctionner
prix_max_ttc
prix_max_ht
prix_exact_ttc
prix_exact_ht

Paramètres additionnels

Dans la réponse a une demande de cotation sont indiquées pour chaque offre de service les paramètres requis et optionnels spécifiques à cette offre. Lorsqu’ils sont déjà spécifiés, la cotation en tiendra compte dans le prix renvoyé (si les paramètres en question ont une incidence sur le prix).

cotation
  shipment
    (letter|package|bulky|pallet)
      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

Mode d’une offre : « COM » (pour le mode commande, signifie que cette offre peut être commandée via EMC) ou « SYN » (pour le mode syndication, signifie que cette offre est comparée à titre indicatif mais ne peut être commandée via EMC).

Types de collecte:

  • 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

Types de livraison:

  • PICKUP_POINT : retrait en point relai
  • HOME : livraison à domicile
  • COMPANY : livraison en entreprise

Les alertes sont des informations importantes à afficher à l’utilisateur (quand l’utilisation de l’API le permet).

Les informations obligatoires (« mandatory_informations ») sont des paramètres qu’il faudra obligatoirement fournir pour commander l’offre concernée. Elles sont normalisées et seront listées en annexe – le code client peut soit décider de les fixer à une valeur donnée, soit les demander à l’utilisateur à l’étape pré-commande (en affichant un checkbox / un edit / un select suivant le type de donnée).

Le prix de l’assurance est renseigné si et seulement si:

  • la requête contient un paramètre « assurance=true »
  • la valeur déclarée est fourni pour l’envoi correspondant dans les paramètres POST (paramètre « valeur »)
  • le type d’objet est différent de 100 (« non spécifié »)
  • le type d’objet est couvert par l’assureur
  • le pays de destination est couvert par l’assureur

Les options sont actives si tous les paramètres GET correspondants sont renseignés lors d’une commande. Les paramètres peuvent apparaître aux mêmes niveaux hiérarchiques que shipper et recipient. 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>3.0</weight>
        <length>11</length>
        <width>8</width>
        <height>7</height>
        <quantity>1</quantity>
      </package>

      <package>
        <weight>3.0</weight>
        <length>11</length>
        <width>8</width>
        <height>7</height>
        <quantity>1</quantity>
      </package>

      <content>10120</content>
      <collection_date>2011-08-22</collection_date>
      <delay>aucun</delay>

      <shipper>
        <type>particulier</type>
        <country>FR</country>
        <zipcode>44000</zipcode>
        <city>NANTES</city>
      </shipper>

      <recipient>
        <type>particulier</type>
        <country>FR</country>
        <zipcode>75008</zipcode>
        <city>PARIS</city>
      </recipient>

      <offer>
        
        <mode>COM</mode>
      
        <url> http://www.envoimoinscher.com/choix.html?envoi=pFR44000j0-pFR75002j60&ope=SOGP&srv=RelaisColis </url>
      
        <operator>
          <code>SOGP</code>
          <label>Relais Colis</label>
          <logo> http://www.envoimoinscher.com/operateurs/SOGP/logo_sogp.gif </logo>
        </operator>
        
        <service>
          <code>Relais Colis</code>
          <label>Relais Colis®</label>
        </service>
        
        <price>
          <currency>EUR</currency>
          <tax-exclusive>10.37</tax-exclusive>
          <tax-inclusive>12.40</tax-inclusive>
        </price>
        
        <collection>
          <type>
            <code>DROPOFF_POINT</code>
            <label>dépôt en point relais</label>
          </type>
          <date>2011-08-24</date>
          <label>Vous déposez votre envoi dans un Relai Colis® à partir du mercredi 24 août</label>
        </collection>
      
        <delivery>
          <type>
            <code>PICKUP_POINT</code>
            <label>retrait en point relais</label>
          </type>
          <date>2011-08-31</date>
          <label>Le Relais Colis® d'arrivée peut être choisi par le destinataire. Mise à disposition en Relais Colis® à partir du mercredi 31 août avant 15h. L'envoi reste à disposition pendant 14 jours</label>
        </delivery>
        
        <alert>
          Vérifiez bien que le poids et les dimensions de votre colis sont exactes. Assurez vous que votre colis ne contient pas de denrées périssables, des bouteilles, des liquides ou des matières dangereuses ou interdites. Dans le cas contraire votre envoi pourrait être détruit ou refusé lors de sa prise en charge dans un Relais Colis®. L'expéditeur s'interdit de remettre en Relais Colis® des documents originaux et uniques dont le remplacement est impossible.
        </alert>
      
        <characteristics>
          <label>Vous déposez votre envoi dans un Relais Colis® à partir du mercredi 24 août</label>
          <label>Le Relais Colis® d'arrivée peut être choisi par le destinataire</label>
          <label>Mise à disposition en Relais Colis® à partir du mercredi 31 août avant 15h. L'envoi reste à disposition pendant 14 jours</label>
          <label>Délai non garanti : le destinataire est informé de la mise à disposition de l'envoi par email</label>
          <label>Suivi en ligne possible</label>
          <label>Assurance contractuelle en cas de perte, déterioration ou spoliation de votre envoi : indemnité de 23€ par kg</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.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.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>SOGP-O1130</value>
                <value>SOGP-O1128</value>
                <value>SOGP-O1164</value>
                <value>SOGP-O1129</value>
                <value>SOGP-O1044</value>
                <value>SOGP-O1113</value>
                <value>SOGP-O1170</value>
                <value>SOGP-O1177</value>
                <value>SOGP-O1154</value>
                <value>SOGP-O1106</value>
              </enum>
            </type>
          </parameter>
          
          <parameter>
            <code>retrait.pointrelais</code>
            <label>choix du point relais d'arrivée</label>
            <type>
              <enum>
                <value>SOGP-A1120</value>
                <value>SOGP-A1246</value>
                <value>SOGP-A1168</value>
                <value>SOGP-A1171</value>
                <value>SOGP-A1070</value>
                <value>SOGP-A1169</value>
                <value>SOGP-A1262</value>
                <value>SOGP-A1138</value>
                <value>SOGP-A1062</value>
                <value>SOGP-A1249</value>
              </enum>
            </type>
          </parameter>
        </mandatory_informations>
      </offer>

      <offer>    
      <mode>COM</mode>
      <url> http://www.envoimoinscher.com/choix.html?envoi=pFR44000j0-pFR75002j60&ope=UPSE&srv=Standard </url>
      
      <operator>
        <code>UPSE</code>
        <label>UPS</label>
        <logo> http://www.envoimoinscher.com/operateurs/UPSE/logo_upse.gif </logo>
      </operator>
      
      <service>
        <code>Standard</code>
        <label>UPS Standard</label>
      </service>
      
      <price>
        <currency>EUR</currency>
        <tax-exclusive>18.41</tax-exclusive>
        <tax-inclusive>22.02</tax-inclusive>
      </price>
      
      <collection>
        <type>
          <code>HOME</code>
          <label>enlèvement à domicile</label>
        </type>
        <date>2011-08-24</date>
        <time>17:30</time>
        <label>Enlèvement de l'envoi à l'adresse de l'expéditeur le mercredi 24 août</label>
      </collection>
      
      <delivery>
        <type>
          <code>HOME</code>
          <label>livraison à domicile</label>
        </type>
        <date>2011-08-25</date>
        <time>19:00</time>
        <label>Livraison à l'adresse du destinataire le jeudi 25 août avant 19:00</label>
      </delivery>
      
      <alert>
        Avant de passer commande, assurez-vous que l'expéditeur pourra imprimer le bordereau d' expédition UPS. Les colis doivent obligatoirement être emballés et leur contenu suffisamment protégé. Un emballage rigide (en bois, en carton triple cannelure, ...) est obligatoire pour tout contenu susceptible d'être déformé ou endommagé. Eviter les espaces vides à l'intérieur des colis. Votre envoi ne doit pas contenir de verre ni d'élément liquide.
      </alert>
      
      <characteristics>
        <label>Enlèvement de l'envoi à l'adresse de l'expéditeur le mercredi 24 août</label>
        <label>Livraison á l'adresse du destinataire le jeudi 25 août avant 19:00</label>
        <label>Délai non garanti</label>
        <label>Livraison contre signature ou cachet commercial</label>
        <label>Suivi en ligne possible</label>
        <label>La responsabilité contractuelle d'UPS est régie et est limitée conformément aux règles applicables (Convention de Varsovie ou Convention CMR, Convention de Montréal)</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.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.email</code>
          <label>email du destinataire</label>
          <type><string/></type>
        </parameter>
        
        <parameter>
          <code>disponibilite.HDE</code>
          <label>Heure de fin de disponibilité pour l'enlèvement</label>
          <type><string/></type>
        </parameter>
        
        <parameter>
          <code>disponibilite.HLE</code>
          <label>Heure de début de disponibilité pour l'enlèvement</label>
          <type><string/></type>
        </parameter>
      </mandatory_informations>
      
      <options>
        <option>
          <code>contre-remboursement</code>
          <name>Contre-remboursement</name>
          <parameter>
            <code>contre-remboursement.selection</code>
            <label>Paramètre de séléction de l'option : Contre-remboursement</label>
            <type><boolean/></type>
          </parameter>
          <parameter>
            <code>contre-remboursement.valeur</code>
            <label>Valeur attendue du contre-remboursement</label>
            <type><float/></type>
          </parameter>
          <price>
            <currency>EUR</currency>
            <tax-exclusive>15.00</tax-exclusive>
            <tax-inclusive>17.94</tax-inclusive>
          </price>
        </option>
      
        <option>
          <code>assurance</code>
          <name>Assurance Ad-Valorem</name>
          
          <parameter>
            <code>assurance.selection</code>
            <label>Paramètre de séléction de l'option : Assurance Ad-Valorem</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>Étui</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</value>
                <value>Manchon mousse</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 utilisée</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>Agrafes et cerclage</value>
                <value>Clous et cerclage</value>
              </enum>
            </type>
          </parameter>
        </option>
      </options>
      </offer>

ans d'expertise

clients satisfaits

de colis envoyés
Des questions ?

Nos experts sont à votre écoute