Set up the AntsRoute module in Odoo

Introduction

The integration between Odoo and AntsRoute allows you to transfer your delivery requests and automatically optimize your routes.

With this connector, you can:

• Send deliveries from Odoo to AntsRoute
• Plan your routes more efficiently
• Track delivery status directly from Odoo

👉 This integration is available from the Odoo apps marketplace.

💡 Good to know: the pick-up & delivery feature is also compatible with this integration.
 

Before you start

Before setting up the integration, make sure you:

• are using odoo.sh
• have a compatible Odoo version: 13.0, 14.0, 15.0, 16.0, 17.0, 18.0 or 19.0
• have installed the following modules: Inventory (Stock), Sales, and Invoicing

Step 1: Install the AntsRoute module

1. Open the Apps module
2. Search for AntsRoute
3. Click Install

👉 The module is now available in your Odoo environment.

Step 2: Configure a warehouse

This step defines the starting point of your deliveries.

1. Go to Inventory
2. Click Configuration > Warehouses
3. Click Create
4. Fill in:
   • Warehouse name
   • Short name (max. 5 characters)
   • Address (required)
   • Opening hours
5. Click Save

💡 Important: the address corresponds to the loading location.
 

Step 3: Create an AntsRoute shipping method

3.1 Set up the method

1. Go to Inventory > Configuration > Shipping Methods
2. Click Create
3. Fill in:
   • Name
   • Provider
4. Check Use AntsRoute
5. Add a delivery product

💡 You can define a fixed price or pricing rules (based on weight, volume, or quantity).
 

3.2 Add the AntsRoute API key

Retrieve the API key:

1. Log in to AntsRoute
2. Click your profile (top right corner)
3. Go to Integrations
4. Click API Key
5. Click “+” (Add)
6. Optionally enter a name
7. Select the associated site
8. Click Create
9. Copy the generated key
10. Click Continue to confirm

Add the key in Odoo:

1. Go back to Odoo
2. Open the AntsRoute tab in your shipping method
3. Paste the API key into the dedicated field

🔑 What is the API key used for?
It securely connects Odoo and AntsRoute.
 

3.3 Choose the planning mode

In Shipping method > AntsRoute > Order destination in AntsRoute, select one option:

• Organize: delivery is scheduled on a specific date
• Basket: delivery is added with a due date and scheduled later

💡 If you use the Pick-up & Delivery feature, select “Pickup delivery enabled” in the AntsRoute Mode field.

This feature allows you to:

• Pick up goods at location A
• Deliver them to location B
• Return to the warehouse multiple times during the day if needed

3.4 Define delivery settings

1. Fill in the following:
   • Average loading time at the warehouse
   • Average unloading time at the customer's
   • Delivery days
   • Warehouse default opening (time from which a load can be carried out at the warehouse)
   • Warehouse default closing (time until which a load can be carried out at the warehouse)
   • Customer default delivery start (time from which a delivery can be completed at the customer's location)
   • Customer default delivery end (time until which a delivery can be completed to the customer's location)
2. Then click Save

Step 4: Create a quotation with delivery

4.1 Add a customer (optional)

1. Go to Sales > Orders > Quotations
2. Click Create
3. Select an existing customer or create a new one:
   • Enter a name
   • Click Create and edit
   • Fill in delivery address and mobile number
   • Click Save

4.2 Add products

1. Click Order Lines
2. Add the products to deliver

4.3 Add delivery

1. Click Add Shipping
2. Select the AntsRoute shipping method
3. Click Add, then Confirm

Step 5: Send the delivery to AntsRoute

5.1 Configure capacities in AntsRoute

Capacities are used to optimize vehicle loading.

Create the following:

• Number (number of items)
• Weight (kg)
• Volume (m³)

To configure them:

1. Go to Settings
2. Open the Capacities tab
3. Click “+” (Add)

Add the Number capacity

Enter the following information:

• Name: Number
• Unit: Unit
• Validation mode: optional

Then click Save.

Add the Weight capacity

Repeat the process with the following information:

• Name: Weight
• Unit: Kg
• Validation mode: optional

Add the Volume capacity

Repeat once more with:

• Name: Volume
• Unit: m³
• Validation mode: optional

💡 Good to know: these capacities are used by AntsRoute to distribute deliveries based on your vehicle constraints (weight, volume, number of items).

5.2 Set vehicle capacities

1. Go to Resources 
2. Click on Vehicles 
3. For each vehicle, click on ... > Edit
4. Enter maximum vehicle capacities for:
   • Number
   • Weight
   • Volume
5. Save

5.3 Create custom fields

To retrieve certain information from Odoo in AntsRoute, you need to create custom fields.

The fields to add are:

• Price
• Description
• Reference

👉 These fields allow order-related information from Odoo to be automatically transferred.

Step 1: Create a category

Before adding fields, you need to create a category:

1. Go to the Settings module
2. Click on the Custom Fields tab
3. Select the Delivery tab
4. Click Create a category
5. Enter a name (e.g. Odoo Fields)
6. Click Save

You can now create your fields.

Step 2: Create custom fields

1. Click Create a field
2. Enter:

Add the Price field

• Name: Price
• Category: select the category created earlier
• Type: Text field

Add the Description field

Repeat the same steps with:

• Name: Description
• Type: Text field

Add the Reference field

Repeat once more with:

• Name: Reference
• Type: Text field

💡 Good to know: once these fields are configured, the corresponding information will automatically appear in your AntsRoute deliveries.

5.4 Set quantities to deliver

1. Open the delivery in Odoo
2. Click Edit
3. Go to the Operations tab
4. Enter quantities in the Done field
5. Save

5.5 Send the delivery

Click Request carrier pickup

👉 The delivery is automatically sent to AntsRoute.

Information available in AntsRoute

Once the delivery is sent from Odoo to AntsRoute, several pieces of information are automatically transmitted and available:

• Reference: corresponds to the Odoo reference, including the quotation number and stock picking
• Description: corresponds to the product reference in Odoo (or the product name if no reference is provided)
• Price: corresponds to the order price
• Weight: indicates the total weight of the products to be delivered (positive integer)
• Number: indicates the number of products to be delivered

👉 This information makes it easier to track deliveries and ensures field teams have all the data they need.

Step 6: Track delivery status

From Odoo:

1. Go to Orders > Orders
2. Open an order
3. Click Delivery
4. Open the AntsRoute Information tab
5. Click Get delivery information

You can view:

• Delivery date
• Status
• Assigned driver
• Customer signature
• Photos
• Comments

💡 Photos are available via attachments.

Data synchronization

To change the sync frequency:

1. Go to Settings > General Settings
2. Click on Activate the developer mode
3. Click on Settings
4. Go to Technical > Scheduled Actions
5. Open AntsRoute – check delivery information
6. Modify the frequency by clicking Edit (top left), then set “Execute every … days”.
7. Save

Conclusion

The integration between Odoo and AntsRoute allows you to manage deliveries seamlessly, from quotation to final tracking.

Once set up, it helps you:

• Save time on planning
• Reduce manual errors
• Improve delivery tracking

👉 If you encounter issues, check first:

• The API key
• Configured capacities
• Address information

🙋 Need help?

If you experience difficulties setting up the integration, you can contact AntsRoute support:

• By email
• Or via the chat available in your web interface