On traite un envoi par commande, on ne traite que les envois simples.

Le payeur est la personne authentifiée (qui doit être un client en compte avec prélèvement differé pour l’instant).

Le pays d’expédition est pour l’instant restreint à la France.

Les paramètres à fournir en POST 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…)) :

type.valeuren euros, obligatoire pour certains opérateurs et certaines destinations, utilisé aussi pour l’assurance valeur déclarée

Paramètre Remarques
platform api / library
platform_version vide / version de la plateforme utilisée
module_version vide / votre numéro de version
type_N.poids
type_N.longueur
type_N.largeur
type_N.hauteur sauf pour pli
code_contenu facultatif, ‘200’ (non spécifié) par défaut – obligatoire (et 200 exclus) si l’on spécifie une valeur déclarée pour l’assurance
type.description description de votre envoi
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
expediteur.societe “nom_de_la_societe” obligatoire si type = entreprise
expediteur.ville
expediteur.adresse numéro et rue – s’il y a plusieurs lignes, les séparer avec ‘|’
expediteur.titre
expediteur.prenom
expediteur.nom
expediteur.email
expediteur.tel
expediteur.tel2
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
destinataire.societe “nom_de_la_societe” obligatoire si type = entreprise
destinataire.ville
destinataire.adresse numéro et rue – s’il y a plusieurs lignes, les séparer avec ‘|’
destinataire.titre
destinataire.prenom
destinataire.nom
destinataire.email
destinataire.tel
destinataire.tel2
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
operateur code de l’opérateur à séléctionner
service code du service à séléctionner – operateur doit être spécifié dans ce cas
prix_max_ttc
prix_max_ht
prix_exact_ttc
prix_exact_ht
url_tracking La page (sur votre serveur) qui va intercepter l’état de vos commandes et mettre à jour
votre suivi interne, toujours fonctionnel mais bientôt obsolète au profit d’url_push
url_push Elle servira à alimenter la page (sur votre serveur) avec des informations sur l’état de vos envois.
Elle vous fournira également les documents associés à vos envois.

Paramètres facultatifs des options

Paramètre Remarques
assurance.emballage le type d’emballage utilisé (choix disponibles : Boîte, Caisse, Bac, Emballage isotherme, Etui, Malle, Sac, Tube)
assurance.fermeture la fermeture utilisée (choix disponibles : Fermeture autocollante, Ruban adhésif, Agrafes, Clous, Collage,
Ruban de cerclage, Sangle ou feuillard, Agraphes et cerclage, Clous et cerclage)
assurance.fixation la fixation utilisée (choix disponibles : Sans système de stabilisation, Film transparent, Film opaque,
Film opaque et sangles, Film transparent et sangles, Sangle ou feuillard uniquement)
assurance.materiau le matériau utilisé (choix disponibles : Carton, Bois, Carton blindé, Film opaque, Film transparent, Métal, Papier,
Papier armé, Plastique et carton, Plastique, Plastique opaque, Plastique transparent, Polystyrène)
assurance.nombre le nombre des colis sur la palette (int, uniquement pour l’envoi d’une palette)
assurance.protection la protection intérieure utilisée (choix disponibles : Sans protection particulière, Calage papier, Bulles plastiques,
Carton antichoc, Coussin air, Coussin mousse, Manchon carton (bouteille), Manchon mousse (bouteille), Matelassage, Plaque mousse,
Polystyrène, Coussin de calage, Sachet bulles)
assurance.selection si true, l’assurance sera prise en compte (et soumise à une validation)
contre-remboursement.selection la sélection de l’option contre remboursement
contre-remboursement.valeur la valeur attendue du contre-remboursement
depot.pointrelais le point relais de dépôt ; string, l’identifiant du point
disponibilite.HDE string; date en format H:i : signifie la disponibilité pour l’enlèvement
disponibilite.HLE string; date en format H:i : signifie la disponibilité pour la livraison
livraison_imperative.DIL la date à laquelle votre colis doit forcément être livré. Dans le tableau des options il est représenté par livraison_imperative.DIL
(string – la date en format d-m-Y, uniquement certains transporteurs)
retrait.pointrelais le point relais de retrait ; string, l’identifiant du point
type_emballage.emballage Le type d’emballage de l’envoi ; string, l’identifiant du type d’emballage (la liste des types d’emballages est retournée par une Cotation sur les offres Colissimo)

S’il n’y a pas d’erreur, la réponse vaut pour confirmation de la commande (indépendamment des éventuelles confirmations par mail).

DTD simplifiée de la réponse :

cotation
  shipment
    (letter|package|bulky|pallet)
      weight
      length
      width
      height?
      quantity
    content
    collection_date
    delay
    description
    shipper
      type
      country
      zipcode
      city
      address
      company?
      title
      firstname
      lastname
      email
      phone
      phone2?
    recipient
      type
      country
      zipcode
      city
      address
      company?
      title
      firstname
      lastname
      email
      phone
      phone2?
  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
  alert*
  characteristics
    label*

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 relai
  • 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 POST correspondants sont renseignés lors d’une commande.

Facture pro-forma

Certaines commandes peuvent exiger les informations supplémentaires qui vont servir à générer une facture pro-forma. Vous devez passer alors les paramètres suivants :

Paramètre Remarques
raison la raison de votre envoi (vente, réparation)
description_en la description du produit envoyé en anglais
description_fr la description du produit envoyé en français
nombre la quantité du produit expédié
valeur la valeur unitaire du produit expédié
origine l’origine du produit envoyé
poids le poids unitaire du produit envoyé
Exemple :
POST /api/v1/order expediteur.pays=FR&expediteur.code_postal=69002&expediteur.type=entreprise&expediteur.ville=Lyon& expediteur.adresse=41%2C+rue+Saint-Augustin+%7C+3e+%C3%A9tage&expediteur.civilite=M&expediteur.prenom=D %C3%A9veloppeur&expediteur.nom=Boxtale&expediteur.email=dev%40boxtale.com&expediteur.tel=0601010101& expediteur.infos=Frapper+3+fois&expediteur.societe=EnvoiMoinsCher.com& destinataire.pays=FR&destinataire.code_postal=75008&destinataire.type=entreprise&destinataire.ville=Paris& destinataire.adresse=4+rue+de+Stockholm&destinataire.civilite=Mme&destinataire.prenom=Autre+pr%C3%A9nom& destinataire.nom=Nom+du+destinataire&destinataire.email=dev%40boxtale.com&destinataire.tel=0601010101& destinataire.infos=&destinataire.societe=Boxtale+SAS& colis_1.poids=4&colis_1.longueur=7&colis_1.largeur=8&colis_1.hauteur=11&collecte=2011-08-23&delai=aucun& code_contenu=10120&operateur=UPSE&service=ExpressSaver&disponibilite.HDE=09%3A00& disponibilite.HLE=19%3A00&prix_max_ttc=20&colis.description=Le+Monde%2C+ann%C3%A9es+1990-1992&assurance.selected=false& platform=api&platform_version=&module_version=1.1

Exemple de réponse

<?xml version="1.0" encoding="UTF-8"?>
  <order>
    <shipment>
      <reference>1108161838UPSE2403FR</reference>
      <package>
        <weight>4.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>entreprise</type>
        <country>FR</country>
        <zipcode>69002</zipcode>
        <city>LYON</city>
      </shipper>
      <recipient>
        <type>entreprise</type>
        <country>FR</country>
        <zipcode>75008</zipcode>
        <city>PARIS</city>
      </recipient>
      <labels>
        <label> 
          http://test.envoimoinscher.com/bordereaux/Y1EZa19quPzkR2FIU1QjxtJpdkrbQzKI/1108161838UPSE2403FR_bordereau_1.pdf 
        </label>
      </labels>
      <offer>
        <mode>COM</mode>
        <url> http://test.envoimoinscher.com/choix.html?envoi=eFR69002j0-eFR75008j60&ope=UPSE&srv=Standard </url>
        <operator>
          <code>Standard</code>
          <label>UPS Standard</label>
          <logo> http://test.envoimoinscher.com/operateurs/UPSE/logo_upse.gif </logo>
        </operator>
        <service>
          <code>Standard</code>
          <label>UPS Standard</label>
        </service>
        <price>
          <currency>EUR</currency>
          <tax-exclusive>12.19</tax-exclusive>
          <tax-inclusive>14.58</tax-inclusive>
          <detail>
            <line>
              <label>Prestation de transport, commande et traitement</label>
              <currency>EUR</currency>
              <tax-exclusive>12.19</tax-exclusive>
              <tax-inclusive>14.58</tax-inclusive>
            </line>
          </detail>
        </price>
        <collection>
          <type>
            <code>COMPANY</code>
            <label>enlèvement en entreprise</label>
          </type>
          <date>2011-08-22</date>
          <time>17:30</time>
        </collection>
        <delivery>
          <type>
            <code>COMPANY</code>
            <label>enlèvement en entreprise</label>
          </type>
          <date>2011-08-23</date>
          <time>19:00</time>
          <label>Livraison à l'adresse du destinataire le mardi 23 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 lundi 22 août</label>
          <label>Livraison à l'adresse du destinataire le mardi 23 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>
      </offer>
    </shipment>
  </order>

ans d'expertise

clients satisfaits

de colis envoyés
Des questions ?

Nos experts sont à votre écoute