User Guide Prestashop 1.6 Carrier Module - Relais Colis
34
Page 1-34 User Guide Prestashop 1.6 Carrier Module
Transcript of User Guide Prestashop 1.6 Carrier Module - Relais Colis
Page 1-34
User Guide
Prestashop 1.6 Carrier Module
Page 2-34
Version Date Rédacteur / Modifi-cateur
Nature des modifications
1.8 3/05/2018 VBA Translation fron french to english
1.9 28/06/2018 VBA Cron details
1.11 10/10/2018 MTA Module Split base and home plus
1.12 21/06/2019 MTA Return benefit
Page 3-34
SUMMARY
1. Mandatory items to use the Relais Colis Module .................................................. 4
2. Implementation ........................................................................................................ 4
How to install .................................................................................................................. 4
Update Note .................................................................................................................... 5
3. Setting Up the module ............................................................................................. 5
4. Configuring parameters for Carrier shipment solutions ...................................... 8
4.1. Countries implementation by « Zones » ................................................................ 8
4.2. Relais Colis and Relais Colis Max ........................................................................... 9
4.2.1 Relais Colis delivery specificities .......................................................................... 10
4.2.2 Relais Colis Max delivery specificities .................................................................. 10
4.3. Home and Home + delivery ................................................................................... 12
4.3.1 Home + : Configuration of the options ................................................................. 12
4.3.2 Products settings ..................................................................................................... 13
4.3.3 Example ................................................................................................................... 15
4.4 Price per weight ........................................................................................................... 16
4.4.1 Price for Relais Colis and Relais Colis Max ............................................................ 17
4.4.2. Price for Home and Home + delivery ....................................................................18
4.5 Multi-parcel................................................................................................................. 19
4.5.1 Configuration of a multiparcel product ................................................................. 19
Multiparcel order .............................................................................................................. 20
4.5.2 Grouping several products in the same parcel ..................................................... 21
4.5.3 Multi-parcel labels ................................................................................................. 22
5. Labels printings ...................................................................................................... 23
6. Consignment note .................................................................................................. 26
7. Relais Colis Webreturns ........................................................................................ 27
7. Tracking a shipment ............................................................................................... 31
8. Tracking Automation .............................................................................................. 31
8.1 Implementation ....................................................................................................... 31
8.2 Cron ......................................................................................................................... 34
Page 4-34
1. Mandatory items to use the Relais Colis Module If your shop is in version 1.6, just install this module and it will be ready for use The merchant has just to sign a contract with Relais Colis before using the Relais Colis carrier module. An activation key will be then given to the merchant to activate the module. This module works with the 1.6 Prestashop CMS. For other prerequisites servers, please consult the Prestashop recommendations.
2. Implementation
How to install The relay colis base module allows you to benefit from relay point delivery and home delive-ry. The modules for several prestashop version are available here : - Prestashop 1.6 : http://shop.quadra-informatique.fr/fr/modules-cms-gratuits/56-relais-colis.html - Prestashop 1.7 : http://shop.quadra-informatique.fr/fr/modules-cms-gratuits/69-relais-colis.html
On prestashop back office, go to modules page. Click on the button « add a new module » then choose your filer. Search your zip module files then click on upload the module.
Once loaded you should find the Relais Colis module.
Please note that after installation, the module ask to be installed again ask you can see on the picture above. If this happens, refresh your back-office page to access to update the in-stalling options of the module (setting, uninstalling, etc…) You must see 4 news shippping carriers :
Page 5-34
Note that the home plus carrier will only be installed if you install the home plus relay colis module. You also must see now 3 new options in the menu.
Update Note Since version 1.0.22 of the module on prestashop 1.6 and version 2.0.5 on prestashop 1.7, it is no longer necessary to install the old parcel plus addons addons to add the Relais Parcel Home Plus. This carrier is now managed in the package relay module since the aforementio-ned versions. In case you have installed this module and you migrate your module to versions greater than or equal to the aforementioned versions, the home package relay module will be uninstalled. You will not take any information about orders or costing options. However the home plus carrier will have to be reconfigured following your upgrade.
3. Setting Up the module To acces to the set up page, clic on the « Configure » button in the list of all modules.
The configuration screen has 4 tabs : One service description tab Your personal account tab (activation key) One advanced settings tab One tab for the shipping events managements
Page 6-34
Enter the activation key in the tab « Your relais colis account » to activate the functions linked to your Relais Colis account and to use the module.
Clic on the button « Save my account informations ».
If the following message appears :
Check if your URL is correct in the advanced settings tab (see the picture below). If everything works, advanced setting tab gives you your ID automatically. The TOP 24 option will be described in chapter 4.
Page 7-34
The link https://ws-modules.relaiscolis.com that appears by default is the one for the run.
To test the module, enter the following URL specially made for tests : https://preprod-ws-modules.relaiscolis.com/
The tab « Events » permits to download .zip file and gives you access to all the shipping events of the parcels.
Page 8-34
4. Configuring parameters for Carrier shipment solutions
In this chapter, we will describe how you can configurate the different Relais Colis solutions.
4.1. Countries implementation by « Zones »
Relais Colis delivers parcels in France and Belgium, so you have to set up the zone parame-ters in Prestashop to handle the delivery in those areas. Go into your back office page, on the « localisation » menu then « zones » menu.
Create 2 areas : one for France and one for Belgium.
Go then to the menu « localization » and then « Countries »
Page 9-34
Select « France » and put it in the France Zone.
Do the same for Belgium if you signed with Relais Colis for the Belgium area. You created now 2 zones : one for France and another one for Belgium. You can now config-ure different prices for the different zones.
4.2. Relais Colis and Relais Colis Max
2 carriers are installed in the module for the delivery in pick up points : Relais Colis and Relais Colis Max. You can see that in the Shipping Menu → Carriers.
Page 10-34
Relais Colis : o delivery of parcels between 0 and 20Kg o maximum size Lenght+widht+Height = 170 cm
Relais Colis Max : o delivery of parcels between 20 and 40Kg o maximum size Lenght+widht+Height = 250 cm
If you signed for the Relais Colis Max service, then you will only see Relais Colis Max in the module.
4.2.1 Relais Colis delivery specificities
The maximum weight is 20kg. The module does not allow to create superior bracket or to modify weight or size parame-ters. If you need to deliver heavier parcels, please contact the Sales department to activate the Relais Colis Max option.
The information of the weight has to be given to all the products you want to ship with Relais Colis, otherwise the Relais Colis map will not appear in the check-out.
4.2.2 Relais Colis Max delivery specificities
This service is proposed only if you subscribed to the option. Please contact the sales service for more details. The maximum weight is 40kg. The module does not allow to create superior bracket or to modify weight or size parame-ters.
Page 11-34
The information of the weight has to be given to all the products you want to ship with Relais Colis, otherwise the Relais Colis map will not appear in the check-out.
Page 12-34
4.3. Home and Home + delivery
This service is proposed only if you subscribed to the option. Please contact the Sales de-partment for more details. Home delivery is proposed with 2 options with Relais Colis, that correspond to 2 different carriers in the module.
- Relais Colis Home : Standard Home Delivery at the bottom of the building, without options
- Relais Colis Home + : different options are proposed, see more details in the follow-ing chapter
4.3.1 Home + : Configuration of the options
This service is proposed only if you subscribed to the option. . Please contact the sales service for more details. To access to the Home + options, go to the back-office menu « module and services » sec-tion, then « configuration prix options relais colis » (installed with the module).
Page 13-34
The list of available options is here :
This list shows all the options included with module, it’s not possible to add some options. You can modify the content or the way you want to present the option on your website. For the example, the Unpacking product (Déballage produit) option.
You can enter the price you want for this option. The option price will be added to the global price of the delivery in the check-out. You can also choose if this option is displayed or not on your website for the final customer. We will see an example later.
4.3.2 Products settings
Page 14-34
Once the options are configurated, your products have to be configurated with the options you want to display for those products. Go to the « Module and services » menu then « Configuration des produits Relais Colis ».
You can see the list of the products proposed on your website.
Select the options to activate. You can also set the number of parcels linked to the product sold. Example : a sleeping set is composed of the mattress, the foots of the mattress, the bedbase. Those products are packed separatedly but have to be sent together to constitute the set. The express delivery options (24h) is available in advanced settings. First contact the sales department to activate this delivery service.
Page 15-34
In that section, you can :
- fix a special price for the express delivery option - fix the maximal hour the order can be done so that the product can be delivered to
your customer the day after the order. - choose to display this option to your customer or not
Please note that the express delivery option is charged once in a order. For example , a cus-tomer who orders 2 products will be charged with the delivery option one time.
4.3.3 Example
Page 16-34
If we set up a product with the assembly option, the customer can : - Choose the basic delivery option for 9 euros that includes the unpacking of the goods - Add or not the assembly option for 5 euros.
The result will be displayed as below in the check-out :
4.4 Price per weight You can set different prices for home delivery function of the weight of the goods sold on your website. Go to « Carriers » in the back-office section, choose one of the Relais Colis Carriers.
Page 17-34
4.4.1 Price for Relais Colis and Relais Colis Max You can set different prices by clusters of weigths, with a limitation of 20 kgs with Relais Colis (or 40 kg for Relais Colis max). For example, you can build a princing system with 3 levels :
- cluster 0- 2 kg for 3 euros - cluster 2 -10 kg for 4 euros - cluster 10-20 kg for 5 euros.
Please note that the module does not permit to make levels upper than the weights limits allowed by Relais Colis (20kg) and Relais Colis Max (40kg)
Page 18-34
4.4.2. Price for Home and Home + delivery Home or Home + can be configurated by cluster of prices and levels of weights. Example by level of prices.
(Example by cluster of weights.
Page 19-34
If needed, you can reboot the prices cluster you made here :
4.5 Multi-parcel The multiparcel function of the Relais Colis carrier module permits to edit several labels if you need to cluster several parcels together.
4.5.1 Configuration of a multiparcel product If we take the example of the bedding set which is composed of the mattress, the bedbase and the feet of the bed. Those 3 elements can be clustered together with one tracking number, for example Each time a bedding set will be ordered, 3 parcels will be automatically generated if the con-figuration below is done. You can fix the number of goods given for a set if you go there (Catalogue > Produits > Modi-fier). A Relais Colis section will permit you to fix the number of articles for the goods you sell and will generate as much labels as you need to ship it.
Page 20-34
Multiparcel order An order with a multiparcel product will automatically propose the appropriate number of labels if you defined previously the number of parcels associate to that good in the product configuration.
You can choose to delete or to add a parcel, the global weight has just to be respected at the end. If not, there will be a message to warn you that a parcel is probably missing. Formulaire Numéro de colis : The tracking number will have 2 more numbers (01, 02,03,04..) that permit to make a difference of content. This number will appear on the label as well. Produit : Pick-up list including all the products included in the order. Poids : The weight of the product. This field is mandatory in cas of modification of the num-ber of parcels. To permit the label reservation, all the products weights have to be specified.
Page 21-34
4.5.2 Grouping several products in the same parcel The multi-parcel function also permit to group together several products in a same parcel. For example : your customer bought a dress and a tee-shirt in the same order. Instead of preparing 2 parcels, it’s possible to prepare just one containing the 2 products. By default, the 2 products will appear separatedly in the sending view.
If you want to regroup them, delete the 2nd parcel clicking on the dustbin.
Add the dress (click on Ajouter) and give it a the same parcel number as the main parcel. Also give the weight of the product.
The unique parcel has been done.
Page 22-34
Only one label has to be printed.
4.5.3 Multi-parcel labels Once the label reservation has been done, you can download the labels by several ways : in the order view or in the list of different orders presented further.
Page 23-34
5. Labels printings
Follow the different steps to print a label. Before printing the label, you must first rRegister the parcel to obtain a tracking number. The registration can be done per order or for several orders
- Go to the order view, and click on « reservation d’étiquette » to register the parcel.
- You can see at the bottom of the order view a Relais Colis section - A tracking number will be associated to the parcel and i twill be then possible to
download the label.
To registrate several parcel numbers, go to the Relais Colis Orders page.
Click on « Commandes Relais Colis ».
Page 24-34
The list of all the orders will appear. You can now select the orders you want to be registered as a tacking number. Click on « Bulk actions » then « Print PDF labels »
The label will be edited in your brower.
Page 25-34
Sometimes the delivery adress can be changed during an order because the customer forgot to give one or because of the action of another module. The order can be saved with the final customer adress instead of the pudo adress :
In the case, the module automatically detects the bug and propose to resolve it by selecting the former pudo adress given in the order by the customer.
Page 26-34
6. Consignment note Go to the menu « Commandes Relais Colis ». Choose the tracking number you want to edit on the consignment note and then click on « Lettre de voiture ».
Confirm by clicking on « Lancer l’édition » to edit the consignment note.
Page 27-34
7. Relais Colis Webreturns
The webreturn is available only if the webmerchant has suscribed to the option. To obtain this option or for more details, please contact the Relais Colis sales department.
The webreturn option permit to you and to your customers to print Relais Colis specific re-turn labels. To activate that option :
- Your Relais Colis account has to be configurated with the Return option - You must activate the Prestashop return option
The customer Journey for Webreturn is this one: - Final customer asks for webreturn authorization from his or her website account - A request goes to the merchant into the Prestashop Back Office - If the merchant approves the webreturn request, the final customer will receive a
webreturn label - The informations used to edit the label are the ones of the import flow expedition
(weight, pudo). Vigilance points :
- The Prestashop webreturn solution works if Relais Colis takes in charge the import flow expedition.
- This solution does not fit with marketplaces webreturn requests
The return processed is based on the Prestashop native process, but Relais Colis module gives you a special interface to manage that. When a customer ask for a return authorization, you can see the customer request in the menu « modules » then « retour Relais Colis ».
Page 28-34
Page 29-34
Click on one of the return request in the list to acces to the detail of this one. If you give to the order the status « attente du colis », you can register the parcel into a re-turn tracking number by clicking on « Reservation du colis »
Note that you can choose different services for your return. These will be proposed according to your contract at relais Colis.
Page 30-34
Once the return tracking number registered, the button « Telecharger » is then available and permit to download the return label.
The final customer will then have the access to the label in his or her website account. The customer has to go into his or her account, then click on « mes retours relais colis »
The customer can now click on the link below to download and print the label by his own.
Page 31-34
7. Tracking a shipment
To track a shipment, the customer has to go into his or her account, on the orders list. Once the order selected, click on the details of this one. A tracking shipment link will be available hiere.
8. Tracking Automation If you need to track all your shipments, you can also set up a cron job that will permit to get an tracking update every hour.
8.1 Implementation In the set up menu, go to « Paramètres avancés » :
Activate the option Cron Job to get an update every hour.
Page 32-34
The differentes status managed by the module are :
Annulé (canceled) En attente de paiement à la livraison En attente de paiement par chèque En attente de paiement PayPal En attente de réapprovisionnement (non payé) En attente de réapprovisionnement (payé) En attente de virement bancaire En cours de préparation Erreur de paiement Expédié Livré Paiement à distance accepté Paiement accepté RC - Déposé en relais RC - En cours de retour RC - Litiges RC - Livraison en cours RC - Non livré RC - Refus Client RC - Reprise en cours RC - Retourné Remboursé
Page 33-34
Here are the events status that can be related to orders :
Correspondance par code evts événement justificatif fichier evts
Expédié AAR AV Colis arrivé à l'agence de distribution
Expédié APF ANA Colis non pris en charge sur la plateforme de tri
Expédié APF EAG Colis pris en charge par Relais Colis
Expédié APF ECP Colis pris en charge sur la plateforme de tri
Expédié APF EJD Colis pris en charge sur la plateforme de tri
Expédié APF EL1 Colis pris en charge sur la plateforme de tri
Expédié APF EL4 Colis pris en charge sur la plateforme de tri
En cours de retour APF EL9 Colis pris en charge sur la plateforme retour
Expédié APF ENG Colis pris en charge sur la plateforme de tri
Expédié APF EPS Colis pris en charge sur la plateforme de tri
En cours de retour APF ERP Colis en cours de retour
Expédié APF GAR Colis en cours de distribution
Expédié APF L1 Colis pris en charge sur la plateforme de tri
Expédié APF L2 Colis pris en charge sur la plateforme de tri
Expédié APF L3 Colis pris en charge sur la plateforme de tri
Retourné APF P5 Colis rendu
Expédié APF PST Colis remis à notre livreur
Expédié APF RAQ Colis arrivé à l'agence de distribution
Retourné APF RDF Colis rendu
En cours de retour APF RPA Colis restitué à l'agence de distribution
Expédié APF SAG Colis en cours d'acheminement
Expédié APF SL2 Colis sorti de la plateforme de tri
Expédié APF SL3 Colis sorti de la plateforme de tri
Expédié APF SL4 Colis sorti de la plateforme de tri
En cours de retour APF SL9 Colis sorti de la plateforme retour
Expédié APF SNG Colis sorti de la plateforme de tri
En cours de retour APF SRA Colis en cours d'acheminement
Expédié CPF SL2 Colis sorti de la plateforme de tri
Expédié MAD MDE Erreur de tri : colis dirigé sur une mauvaise agence
Expédié MAD MDI Erreur de tri : colis dirigé sur une mauvaise tournée
En cours de retour REN 1P Avisé 1er passage
En cours de retour REN R2 Environnement de livraison inadapté
En cours de retour REN R20 Commande incomplète
En cours de retour REN R3 Refus client lors de la livraison
En cours de retour REN R30 Reprise effectuée
En cours de retour REN R32 Reprise annulée par l'enseigne
En cours de retour REN R33 Echec Reprise : Client injoignable
En cours de retour REN R40 Commande en double
En cours de retour REN R41 Hors secteur de livraison agence
En cours de retour REN R42 Stop livraison confirmé
En cours de retour REN R43 Packaging non conforme
En cours de retour REN R44 Refus client lors de la prise de RDV
En cours de retour REN R45 Refus prestation ECO
En cours de retour REN R46 Erreur de produit
En cours de retour REN R47 Refus suite déballage
En cours de retour REN R4a Client injoignable malgré avis de passage
En cours de retour REN R4b Client injoignable malgré avis de passage
En cours de retour REN R5 Délai trop long
En cours de retour REN R6 Désaccord sur règlement
En cours de retour REN R7a Retour à la demande de Relais Colis
En cours de retour REN R7b Retour à la demande de Relais Colis
En cours de retour REN R8 Colis endommagé
Livraison en cours RST 1P Avisé 1er passage
Livraison en cours RST 2P Avisé 2ème passage, colis en retour
Livraison en cours RST CA Coordonnées du client incomplètes
Livraison en cours RST CPS Changement de prestation de livraison
Livré SOL LIC Colis livré
Livré SOL LID Colis livré
Livré SOL LIM Colis livré
Livré SOL LIP Colis livré
Livré SOL LIR Colis livré
Livré SOL LIS Colis livré
Livré SOL LIV Colis livré
Litige SOR R18 Colis endommagé, en cours de retour
En cours de retour SOR R2 Environnement de livraison inadapté
En cours de retour SOR R20 Commande incomplète
Litige SOR R25 Colis en litige
Refus Client SOR R3 Refus client lors de la livraison
En cours de retour SOR R30 Reprise effectuée
Refus Client SOR R31 Reprise refusée par le client
En cours de retour SOR R32 Reprise annulée par l'enseigne
En cours de retour SOR R33 Echec Reprise: Client injoignable
En cours de retour SOR R34 Echec Reprise : Attente commande échange
En cours de retour SOR R40 Commande en double
En cours de retour SOR R41 Hors secteur de livraison agence
En cours de retour SOR R42 Stop livraison confirmé
En cours de retour SOR R43 Packaging non conforme
Refus Client SOR R44 Refus client lors de la prise de RDV
Refus Client SOR R45 Refus prestation ECO
En cours de retour SOR R46 Erreur de produit
Refus Client SOR R47 Refus suite déballage
En cours de retour SOR R4a Client injoignable malgré avis de passage
En cours de retour SOR R4b Client injoignable malgré avis de passage
En cours de retour SOR R5 Délai trop long
En cours de retour SOR R6 Désaccord sur règlement
En cours de retour SOR R7a Retour à la demande de Relais Colis
En cours de retour SOR R7b Retour à la demande de Relais Colis
En cours de retour SOR R8 Colis endommagé
En cours de retour SOR RNC Colis hors norme, en cours de retour
En cours de retour SOR RPP Colis arrivé en avarie sur la plateforme de tri, en cours de retour
Livraison Domicile
Page 34-34
8.2 Cron Create the following job cron to get the tracking parcels update automation every hour and to run the following php command : php /www/relaiscolis/1617/modules/relaiscolis/cron.php >/dev/null 2>&1 The access path has to be adapted depending of your server . Example : /www/monsite.com/modules/relaiscolis/cron.php>/dev/null 2>&1 Here’s an example to put in a crontab : #RC get EVTS 00 06-22 * * 1-6 php /www/relaiscolis/1617/modules/relaiscolis/cron.php >/dev/null 2>&1
Correspondance par code evts événement justificatif fichier evts
Expédié AAR AV Colis arrivé à l'agence de distribution
Expédié APF ECP Colis pris en charge sur la plateforme de tri
Expédié APF EJD Colis pris en charge sur la plateforme de tri
Expédié APF EL1 Colis pris en charge sur la plateforme de tri
Expédié APF EL4 Colis pris en charge sur la plateforme de tri
En cours de retour APF EL9 Colis pris en charge sur la plateforme retour
Expédié APF ENG Colis pris en charge sur la plateforme de tri
Expédié APF EPS Colis pris en charge sur la plateforme de tri
En cours de retour APF ERP Colis en cours de retour
Expédié APF L3 Colis pris en charge sur la plateforme de tri
Retourné APF P5 Colis rendu
Expédié APF RAQ Colis arrivé à l'agence de distribution
Retourné APF RDF Colis retourné à vos entrepôts
En cours de retour APF RPA Colis restitué à l'agence de distribution
Expédié APF SL3 Colis sorti de la plateforme de tri
En cours de retour APF SL9 Colis sorti de la plateforme retour
Expédié APF SNG Colis sorti de la plateforme de tri
En cours de retour APF SRA Colis en cours d'acheminement
En cours de retour APF SRL Colis en cours de retour
Déposé en relais DEP REL Colis déposé au Relais Colis d'expédition
Expédié MAD MDE Erreur de tri : colis dirigé sur une mauvaise agence
Expédié MAD MDI Erreur de tri : colis dirigé sur un mauvais relais
Déposé en relais REN AV Colis déposé au Relais Colis d'expédition
En cours de retour REN AGL Colis en cours de retour à l'agence
En cours de retour REN AUT Colis refusé par le client
En cours de retour REN AVA Colis endommagé, en cours de retour
En cours de retour REN DJR Doublon, colis déjà livré
En cours de retour REN R3 Refus client lors de la livraison
En cours de retour REN R5 Délai trop long
En cours de retour REN R7b Retour à la demande de Relais Colis
En cours de retour REN R8 Colis endommagé
En cours de retour REN R9 Délai instance dépassé
Expédié RST EAR Colis en cours de livraison au relais
Ne pas retranscrire ce statut RST LD Colis livré
Expédié RST MDR Colis en cours de distribution au relais
Déposé en relais RST REC Colis réceptionné par le relais
Expédié RST RL Colis en cours de distribution vers un autre relais
Expédié RST RMQ Colis en cours de distribution au relais
Livré SOL LID Colis livré
Livré SOL LIR Colis livré
Livré SOL LIS Colis livré
Livré SOL LIV Colis livré
En cours de retour SOR AVA Colis endommagé, en cours de retour
Livré SOR LIV Colis livré
Litige SOR R18 Colis endommagé, en cours de retour
Litige SOR R25 Colis en litige
Refus Client SOR R3 Refus client lors de la livraison
En cours de retour SOR R8 Colis endommagé
En cours de retour SOR RNC Colis hors norme, en cours de retour
En cours de retour SOR RPP Colis arrivé en avarie sur la plateforme de tri, en cours de retour
Ne pas retranscrire ce statut SOT R11 Soldé et remis la Poste
Livraison en point Relais
