Set up the AntsRoute module on Prestashop

AntsRoute offers a wide range of integrations. In particular, we have an integration with the PrestaShop platform.

AntsRoute module on PrestaShop is available for online shop wishing to organise the deliveries themselves or for carriers who make deliveries for one or more online sales sites. Setting up the AntsRoute module on the PrestaShop platform is quick and easy. Just follow these few steps:

• Step 1: Upload the AntsRoute module on PrestaShop
• Step 2: Create the capacities 'Number' and 'Weight' on AntsRoute
• Step 3: Determine the capacities of vehicles
• Step 4: Create the custom fields 'Description', 'Price' and 'Reference' on AntsRoute
• Step 5: Retrieve the AntsRoute API key
• Step 6: Set up the AntsRoute module in PrestaShop
• Step 7: Activate the pick-up and delivery (optional)

Step 1: Upload the AntsRoute module on PrestaShop

☝️ Good to know: To try out this integration during your trial period, you can contact the support team directly by phone on +33 7 82 95 83 08 or by email at lea.brice@antsroute.com to receive the integration file in ZIP format.

1. Get the .zip file to upload on PrestaShop.
2. Log into your PrestaShop account.
3. Go to 'Modules'. 
4. Click on 'Module Catalog'.
5. Click on the button 'Upload a module'.

   

6. Select the file (.zip format) to upload from your device.

   

💡 After having uploaded the AntsRoute module, it is visible in the 'IMPROVE' menu of your PrestaShop account.

Step 2: Create the capacities 'Number' and 'Weight' on AntsRoute

These capacities enable the management of the quantities (number of parcels and weight) that each vehicle can carry during a route.

First capacity 'Number'

1. Go to the 'Settings' module.
2. Click on the tab 'Capacities'.
3. Click on the button 'Add'.

   

4. Fill in the first capacity: 
   • Number (Name) 
   • Unit (Unit)
   • Optional (Validation mode)
5. Click on the button 'Save'.

   

💡 Make sure to follow the use of upper and lower case letters for ‘Number’ to enable data synchronization between AntsRoute and PrestaShop.

Second capacity 'Weight'

1. Click on the button 'Add'.
2. Fill in the second capacity: 
   • Weight (Name)
   • Kg (Unit)
   • Optional (Validation mode)
3. Click on the button 'Save'.

   

💡 Make sure to follow the use of upper and lower case letters for ‘Weight’ to enable data synchronization between AntsRoute and PrestaShop.

Step 3: Determine the capacities of vehicles

1. Go to the 'Resources' module.
2. Click on the tab 'Vehicles'.
3. For the first vehicle, click on '…' and 'Edit'.

   

4. Determine the quantities 'Number' that can be carried by the vehicle.
5. Determine the quantities 'Weight' that can be carried by the vehicle.
6. Click on the button 'Save'.

   

7. Click on the button 'Confirm'.
8. Repeat these steps for the other vehicles.
   

   

Step 4: Create the custom fields 'Description', 'Price' and 'Reference' on AntsRoute

1. Create a new category

The categories enable to group custom fields to make the information easier to read. For example, a category 'Custom fields' or 'PrestaShop fields'.

1. Go to the 'Settings' module.
2. Click on the tab 'Custom fields'.
3. Click on the tab 'Field service' (or delivery).
4. Click on the button 'Create a category'.

   

5. Determine the 'Name' of this category.
6. Click on the button 'Save.

   

2. Add the custom field 'Price'

1. Click on the button 'Create a field'.

   

2. Fill in the first field: 
   • Price (Name)
   • Text type (Field type)
3. Click on the button 'Save'.

   

💡 Make sure to follow the use of upper and lower case letters for ‘Price’ to enable data synchronization between AntsRoute and PrestaShop.

3. Add the custom field 'Description'

1. Click on the button 'Create a field'.
2. Fill in the second field: 
   • Description (Name)
   • Text type (Field type)
3. Click on the button 'Save'.

   

💡 Make sure to follow the use of upper and lower case letters for ‘Description’ to enable data synchronization between AntsRoute and PrestaShop.

4. Add the custom field 'Reference'

1. Click on the button 'Create a field'.
2. Fill in the third field: 
   • Reference (Name)
   • Text type (Field type)
3. Click on the button 'Save'.

   

💡 Make sure to follow the use of upper and lower case letters for ‘Reference’ to enable data synchronization between AntsRoute and PrestaShop.

Step 5: Retrieve the AntsRoute API key

1. Click on the blue circle at the top right.
2. Click on the button 'Integrations'.
3. Click on 'API keys'.

   

4. Click on the button 'Add'.
5. Select the site for which to generate the API key.
6. Click on the button 'Create'.

   

7. Click on 'Copy'
8. Click on the button 'Continue'.

   

9. Paste the API key into a secure document.

💡 The API key will be required later when setting up the plugin on PrestaShop. If you lose the AntsRoute API key, you can generate a new one at any time.

Step 6: Set up the AntsRoute module in PrestaShop

SET UP THE GENERAL SETTINGS

1. From the PrestaShop account, click on 'IMPROVE'.
2. Click on 'AntsRoute'.
3. Click on 'Configuration'.
4. Click on 'GENERAL SETTINGS'.
5. Determine the 'Choice of carrier'.
6. Determine the 'Delivery initiator'.
7. Determine the 'Cancel initiator'.
8. Paste the 'API key' created in AntsRoute during the previous step.
9. Determine the tab in which the deliveries are scheduled ('Adding the order') :
   • 'In the intervention basket' ;
   • 'In the module organize'.
10. Click on the button 'Save'.

    

💡 The 'Delivery initiator' is the PrestaShop action that triggers a delivery. For example, 'Pending payment'. As soon as this action is 'validated' on PrestaShop, the delivery is scheduled on AntsRoute. The 'Cancel initiator' is the PrestaShop action that triggers the cancellation of a delivery. For example, 'Payment refused'. As soon as this action is 'enabled' on PrestaShop, the delivery is cancelled on AntsRoute.

SET UP THE DELIVERY SETTINGS

1. Click on 'DELIVERY SETTINGS'.
2. Determine the 'Delivery time slots'.
3. Determine the 'Delivery deadline', i.e. the number of working days between the order date and delivery date.
4. Determine the 'Delivery time' in minutes, i.e. the time needed to unload the goods from the vehicle and hand them over to the customer.
5. Click on the button 'Save'.

   

💡 The deadlines are given in working days, with D corresponding to the day of the order.

Step 7: Activate the pick-up and delivery (optional)

For companies whose drivers make several returns to the depot during their routes to reload the vehicle, it is necessary to activate the 'Pick-up & Delivery' features.

ACTIVATE THE FEATURE IN ANTSROUTE

1. Go to the 'Settings' module.
2. Click on the tab 'Settings'.
3. Click on 'General settings'.
4. Enable the option 'Activate the pickup & delivery features'.
5. Click on the button 'Save'.

   

ACTIVATE THE FEATURE ON PRESTASHOP

1. Click on the tab 'IMPROVE'.
2. Click on 'AntsRoute'.
3. Click on 'Settings'.
4. Click on 'PICK-UP & DELIVERY'.
5. Set the toggle 'Enable pick-up & delivery' on 'YES'.
6. Determine the 'Deposit (warehouse) address'.
7. Determine the 'Deposit name'.
8. Determine the 'Loading time'.
9. Determine the 'Loading time slots'.
10. Click on the button 'Save'.

    

💡 The deposit is the place where the goods are loaded.