Set up the AntsRoute integration with Zapiet - Pickup + Delivery for Shopify – Help center

AntsRoute offers a wide range of integrations. In particular, we have an integration with the zapiet platform. If you have a Shopify e-commerce site, we can integrate it with AntsRoute via Zapiet.

1. Requirements

Have an AntsRoute account from Essential or 7-day free trial;
Retrieve an API key on AntsRoute;
Have a Zapiet - Pickup + Delivery app;
Delivery date and time picker enabled in Zapiet - Pickup + Delivery.

💡 To enable the customer to choose a delivery date, go to Zapiet - Pickup + Delivery > Settings > Local delivery > Date and time pickers. For more details, read Zapiet Delivery date and time pickers article.

Countries in which AntsRoute integration is available:

Europe: Austria, Belgium, Czech Republic, Denmark, Finland, France, Germany, Greece, Hungary, Ireland, Italy, Luxembourg, Netherlands, Norway, Poland, Portugal, Romania, Spain, Sweden, Switzerland, United Kingdom.
Africa: Algeria, Benin, Cameroon, Côte d’Ivoire, Egypt, Ethiopia, Ghana, Kenya, Mali, Madagascar, Morocco, Nigeria, Réunion, Rwanda, Senegal, South Africa, Tanzania, Togo, Tunisia, Uganda.
North America: Canada, Mexico, United States.
South America: Argentina, Bolivia, Brazil, Chile, Colombia, Costa Rica, Dominican Republic, Ecuador, El Salvador, French Guiana, Guatemala, Honduras, Nicaragua, Panama, Paraguay, Peru, Uruguay.

2. Retrieve the AntsRoute API key

Click on the blue circle at the top right.
Click on the tab “Integrations”.
Click on “API keys”.
Click on the button “Add”.
Select the site for which to generate the API key.
Click on the button “Create”.
Click on the button “Copy”.
Click on the “Continue” button.

💡 The API key which has just been generated should be copied and pasted into a secure document, as you will be asked for it later on in Zapiet. If you lose the AntsRoute API key, you can generate a new one at any time.

3. Connect AntsRoute to Zapiet (Store Pickup + Delivery)

Go to the tab “Apps”.
From the search bar, click on “Zapiet - Pickup + Delivery”.
Click on “Settings” in the menu on the left.
Click on “Fleet management”.
Search AntsRoute in the list of integrations and click on “Activate AntsRoute”.
Enter the API key retrieved during the previous step.
Click on “Activate AntsRoute”.

4. Set up the AntsRoute module on Zapiet

After activation, you should see the AntsRoute application settings page.

💡 If not, you can go to “Apps” > “Zapiet - Pickup + Delivery” > “Settings” > “Fleet management” > “AntsRoute” > “Configure settings”.

Scroll down and determine the “Duration”.
Choose the “Type” (or “Delivery type”).
Determine the support email address.
Choose the store (Locations) for which orders are sent to AntsRoute to manage deliveries.
Click on the “Save” button.

💡 The “Duration” is the default time required to unload the goods from the vehicle and hand them over to the customer. The input value must be a positive integer. For example, 12. If you let this field blank, it will be 10 minutes by default.

💡 The support email address is the address we use to let you know if there are any problems with the sending of deliveries to AntsRoute.

💡 The “Delivery” is the best option if you use only one Zapiet site as a warehouse (starting point) for local delivery. Please note that the address of the AntsRoute site and the address of the Zapiet site must be the same for optimal route optimisation.

💡 The “Pickup & delivery” option allows you to manage orders from multiple Zapiet pickup locations before the delivery. Please note that to optimise Pickup & Delivery orders, you must subscribe to an offer from the Pro plan. It is also available during the 7-day trial period. The function must be activated on AntsRoute beforehand. Read our support article to learn more about the steps to follow.

☝️ Good to know: If you choose the “Pickup & Delivery” option, it’s better to determine the custom location for each vehicle in AntsRoute. The addresses defined correspond to the start and end points of the routes. You can use the same addresses as the one of your Zapiet locations. To do this, go to AntsRoute > “Resources” > “Vehicles” > “...” > “Edit” > “Location” > “Custom”. Another option is to activate the geographical sectorisation, to assign each delivery driver to a specific working area around the Zapiet location.

5. Set up the Zapiet Location Custom Attributes (Pickup & Delivery only)

If you selected the “Pickup & Delivery” option while setting up the AntsRoute integration, you can add extra information about the Loading (Pickup) Location to improve the order route optimisation. To set up this, go to “Apps” > “Zapiet - Pickup + Delivery”:

Click on “Location” in the menu on the left.
Click on one of the locations selected during the previous step.
Scroll down to “Custom attributes” and enter the values needed.
Click on the “Save” button.

💡 The “Custom attribute 1” is the Loading (Pickup) Duration at the Zapiet Location. By default, it’s 10 (minutes). The value must be a positive integer. For example, 12.

💡 The “Custom attribute 2” is the Loading (Pickup) Time Slot at the Zapiet Location. By default, it’s 00:00-23:59. The format must be HH:HH-MM:MM. For example, 08:00-10:00.

💡 The “Custom attribute 3” is the Loading (Pickup) Comments. This field is used to add some instructions for delivery drivers about the delivery or the customer.

☝️ Good to know: The information is then displayed in the details of a Pickup & Delivery order on AntsRoute. Here's an overview of how it looks in AntsRoute:

6. Create the capacities “Number” and “Weight” on AntsRoute

The creation of these capacities enables management of the quantities that can be carried by each of the vehicles during a route. This step is mandatory.

The capacity “Number”

Go to the “Settings” module.
Click on the tab “Capacities”.
Click on the button “Add”.
Fill in the first capacity:
- Number (Name) ;
- Items (Unit) ;
- Optional (Validation mode).
Click on the “Save” button.

The capacity “Weight”

Click on the button “Add”.
Fill in the second capacity:
- Weight (Name) ;
- g (Unit) ;
- Optional (Validation mode).
Click on the “Save” button.

💡 If you recently created your AntsRoute account, this capacity is created automatically. Just change the unit from kg to g. To do this, click on “…” > “Edit”.

7. Determine the capacities of the vehicles

Go to the “Resources” module.
Click on the tab “Vehicles”.
For the first vehicle, click on “…” and “Edit”.
Determine the quantity “Number” which can be carried by the vehicle.
Determine the quantity “Weight” which can be carried by the vehicle.
Click on the “Save” button.
Click on the “Confirm” button.
Repeat these steps for each vehicle.

8. Create custom fields on AntsRoute (optional)

The creation of custom fields makes it possible to send extra information from Shopify to AntsRoute. For example, the description and price of the items, the payment method, etc.

💡 The use of these custom fields is optional. If you use this function, make sure to enter exactly the same name as described below.

Create a new category (Delivery)

The creation of a category is useful for grouping custom fields about the deliveries and making the information easier to read. For example, “Zapiet Custom Fields”.

Go to the “Settings” module.
Click on the “Custom fields” tab.
Click on the “Delivery” tab.
Click on the “Create a category” button.
Enter a “Name” for this category.
Click on the “Save” button.

💡 The custom fields that you will create right after should be added to this category.

Create “Price” custom field

The price is the total value of the Shopify order (for example, 12.50).

💡 If you recently created your AntsRoute account, this custom field was automatically created. You can just add it to the new category you have just created. To do this, click on “...” > “Edit”.

Click on the “Create a field” button.
Enter the name “Price”.
Select the category you have just created.
For the field type, choose “Text type”.
Click on the “Save” button.

💡 If necessary, you can decide to make the custom field private, i.e. not making it visible on the driver's mobile application. To do this, just check the box “Private” when adding the field.

☝️ Good to know: If necessary, you can add other custom fields by following the same steps:

Currency code - the currency code of the Shopify order (for example, EUR, USD, etc.)
Payment status - the status of customers payment (for example, paid)
Payment method - the payment method the customer used (for example, Shopify Pay)
Total discount - the total discounts applied to the Shopify order (for example, 5.99)
Total shipping price - the total shipping price of the Shopify order (for example 8.00)

Create a new category (Customer file)

The creation of a category is useful for grouping custom fields about the customer file and making the information easier to read. For example, “Zapiet Custom Fields”.

Go to the “Settings” module.
Click on the “Custom fields” tab.
Click on the “Customer file” tab.
Click on the “Create a category” button.
Enter a “Name” for this category.
Click on the “Save” button.

Create “Address Line 2” custom field

Click on the “Create a field” button.
Enter the name “Address Line 2”.
Select the category you have just created.
For the field type, choose “Text type”.
Click on the “Save” button.

9. Enable the “Item management” functions

By using the item database, you can enter the items that your company offers and that your drivers deliver during their routes. Each line item from the integrated Shopify order is automatically created in the database and has this structure:

Reference*: {{the item's SKU}}-{{the ID of the item}}
Item name*: {{the title of the product}}-{{the title of the product variant}}
Price*: {{The price of the item}}

Here's an overview of how it looks in AntsRoute:

☝️ Good to know: At the time of validating the delivery, delivery drivers can indicate whether items have been delivered in conformity, delivered with anomalies, or not delivered. If the option is enabled, they can indicate the quantities of items actually delivered. You can also ask your drivers to fill in extra fields depending on the status of the item selected.

Here are the steps to follow to enable the “Item management” functions on AntsRoute. To learn more about this function, read our support article.

Go to the “Settings” module.
Click on the “Settings” tab.
Click on “General settings”.
Enable the function “Package or item management”.
Select the “Item management” option.
Click on the “Save” button.

10. Send orders to AntsRoute

💡 To send orders to AntsRoute, the customers must select the “Local Delivery” option during checkout. The customers can choose the delivery date and time slot.

💡 If you have activated the management of items and the different custom fields, here is how orders look in AntsRoute.

11. Delivery status

The status is updated on the different platforms as orders or deliveries are updated.

AntsRoute State	Zapiet Status	Shopify Delivery Status
Unassigned and Planned	Pending (or Requires preparation)	Empty
Ongoing	Out for delivery	Out for delivery
Done	Order has been delivered	Delivered
Cancelled	Attempted	Attempted delivery
Archived	Cancelled	Failed delivery

💡 The AntsRoute status is updated in Zapiet every 4-5 minutes.

💡 If an order is "Canceled" in Shopify, it becomes "Archived" in AntsRoute immediately.