Ce document a pour but de présenter les paramètres utilisés lors de l'interaction avec l'API EnvoiMoinsCher.com.
Pour plus d'informations sur les paramètres, la description des classes, veuillez-vous référer à la documentation de la librairie, au quick start .
Les options
| Nom de l'option | Nom du paramètre | Description |
| Assurance AXA | assurance | Afin que l'assurance proposée par EnvoiMoinsCher soit prise en compte, veuillez renseigner également les paramètres suivants : - assurance.selection (true) - si true, l'assurance sera prise en compte (et soumise à une validation) - assurance.valeur - la valeur des objets à assurer - assurance.description - la description des objets à assurer - assurance.emballage - le type d'emballage utilisé (choix disponibles : Boîte, Caisse, Bac, Emballage isotherme, Etui, Malle, Sac, Tube) - 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.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.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.nombre - le nombre des colis sur la palette (int, uniquement pour l'envoi d'une palette) |
| Contre-remboursement | contre-remboursement | Cette option permet au destinataire de payer la valeur réelle du produit à sa réception (c'est le livreur qui
collecte la somme qui sera ensuite reversée au vendeur de l'objet). Le paramètre à passer dans le tableau
avec les options est contre-remboursement.valeur (float). Il signifie la valeur attendue du contre-remboursement . Il faut également passer contre-remboursement.selection (bool) en true. |
| Date impérative de livraison | livraison_imperative | Ce paramètre signifie 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; voir plus sur date() en PHP) |
| Description de l'envoi | description | Le paramètre est demandé pour l'assurance AXA. Il se traduit par description (string). |
| Disponibilité pour l'enlèvement du colis | disponibilite | Certains transporteurs exigent cette information : la disponibilité de l'expéditeur à l'enlèvement et celle du destinataire pour la livraison de l'envoi. Dans ce cas vous êtes amené à passer les
paramètres suivants :
- disponibilite.HDE (string; date en format H:i; voir plus sur date() en PHP) : signifie la disponibilité pour l'enlèvement - disponibilite.HLE (string; date en format H:i; voir plus sur date() en PHP) : signifie la disponibilité pour la livraison |
| Point de proximité pour le dépôt | depot | Si vous avez choisi un transporteur dont le départ s'effectue par un dépôt en point de proximité, vous devez spécifier ce paramètre : depot.pointrelais (string, l'identifiant du point). |
| Point de proximité pour le retrait | retrait | Si vous avez choisi un transporteur dont la livraison s'effectue par
un retrait en point de proximité, vous devez spécifier ce paramètre : retrait.pointrelais (string, l'identifiant du point).
Vous pouvez laisser le destinataire de choisir le point relais dans lequel il va retirer son envoi. Pour faire cela, passez les deux paramètres : "retrait.pointrelais" => "differe", "retrait.choix_differe" => true |
| Valeur déclarée du contenu | valeur_declaree | Certains transporteurs exigent l'indication de la valeur du contenu de l'envoi. Pour passer ce paramètre, utilisez valeur_declaree.valeur (float). |
Les paramètres expéditeur/destinataire
| Nom de l'option | Nom du paramètre | Type | Description |
| Adresse | adresse | obligatoire | L'adresse (la rue, l'étage, le numéro de chambre...) de la personne. Vous avez la possibilité d'indiquer au maximum 3 lignes pour tous les transporteurs sauf TNT. Pour TNT le nombre des lignes maximal est 2. Pour passer une adresse composée de plusieurs lignes, veuillez utiliser le séparateur |. Pour un logement 200 situé à la rue Inconnue on aura donc : "1, rue Inconnue | logement 200". Chaque ligne accepte la valeur d'une longueur de 30 caractères. |
| Adresse e-mail | obligatoire | L'adresse e-mail de la personne, utilisée pour l'envoi des documents (factures, bordereaux...). | |
| Civilité | civilite | obligatoire | La civilité de la personne (M, Mme, Mlle) |
| Code postal | code_postal | obligatoire | Le code postal de l'expéditeur ou du destinataire. |
| Entreprise | entreprise | obligatoire si type = entreprise | Si la personne possède un statut professionnel, vous devez indiquer le nom de l'entreprise en question. |
| Informations complémentaires | infos | obligatoire | Les informations complémentaires qui aideront le livreur à effectuer l'enlèvement ou la livraison (code, nom sur l'interphone, instructions, etc.). |
| Nom | nom | obligatoire | Le nom de l'expéditeur ou du destinataire. |
| Numéro de téléphone | tel | obligatoire | Le numéro de téléphone auquel vous serez joignable par notre service client et par le transporteur (p.ex.: pour demander votre disponibilité). Si vous ne connaissez pas le numéro de téléphone du destinataire, saisissez celui de l'expéditeur. |
| Pays | pays | obligatoire | Le pays de la personne représenté par le code ISO. L'expéditeur ne peut prendre comme valeur que "FR". |
| Prénom | prenom | obligatoire | Le prénom de l'expéditeur ou du destinataire. |
| Type | type | obligatoire | Le statut de la personne : particulier ou entreprise. |
| Ville | ville | obligatoire | La ville de la personne. |
Les paramètres de l'envoi (colis, pli, encombrant, palette)
| Nom de l'option | Nom du paramètre | Type | Description |
| Hauteur | hauteur | obligatoire | La hauteur de votre envoi, exprimé en cm. |
| Largeur | largeur | obligatoire | La largeur de votre envoi, exprimée en cm. |
| Longueur | longueur | obligatoire | La longueur de votre envoi, exprimée en cm. |
| Longueur de la palette | palletDims | obligatoire si l'envoi = palette | Veuillez vous référer au tableau $palletDims placé dans la classe Env_Quotation pour connaître les paramètres acceptés. |
| Nombre | nombre | facultatif | Le paramètre qui indique le nombre de colis à expédier. Il est facultatif. Si vous ne le passez pas, il prendra 1 pour valeur. |
| Poids | poids | obligatoire | Le poids de votre envoi, exprimé en kg. |
Les paramètres de la cotation et de la commande
| Nom de l'option | Nom du paramètre | Type | Description |
| Catégorie de contenu | code_contenu | obligatoire | Le code de la catégorie de contenu. |
| Date d'enlèvement | collecte | obligatoire | La date d'enlèvement souhaitée, en format d-M-Y (voir plus sur date() en PHP). |
| Information externe | reference_externe | facultatif | Dans ce paramètre vous pouvez passer une information quiservira à identifier la commande d'achat sur votre e-boutique, puis à la relier à sa commande de livraison EnvoiMoinsCher. |
| Délai | delai | obligatoire | Il prend comme valeur : - aucun : offres de transport triées par prix décroissant - course : offres de course avec livraison dans la journée |
| Prix exact en HT | prix_exact_ht | facultatif | Le prix exact en HT pour la sélection d'offres ou la passation de commande. Exprimé en €. |
| Prix exact TTC | prix_exact_ttc | facultatif | Le prix exact en TTC pour la sélection d'offres ou la passation de commande. Exprimé en €. |
| Prix maximal HT | prix_max_ht | facultatif | Le prix maximal en HT pour la sélection d'offres ou la passation de commande. Exprimé en €. |
| Prix maximal TTC | prix_max_ttc | facultatif | Le prix maximal en TTC pour la sélection d'offres ou la passation de commande. Exprimé en €. |
| Service | service | facultatif | Le nom du service (de l'offre) que vous souhaitez commander. |
| Transporteur | operateur | facultatif | Le code du transporteur que vous avez choisi pour votre envoi. Si vous ne l'indiquez pas : - dans la cotation vous recevrez toutes les offres de transport - vous allez commander la 1ère offre correspondant au paramète delai dans votre commande |
| URL de suivi | url_tracking | facultatif | La page (sur votre serveur) qui va intercepter l'état de vos commandes. en savoir plus |