Support > AntsRoute Plugin > Set up the AntsRoute module for WooCommerce

Set up the AntsRoute module for WooCommerce

AntsRoute module for WooCommerce is available for online shop wishing to organise their deliveries themselves or for carriers who make deliveries for one or more online sales site(s). Setting up the AntsRoute module for WooCommerce is quick and easy. Just follow these few steps:

Step 1: Upload the AntsRoute plugin on WordPress

Retrieve the .zip file of this plugin to import on WordPress.

Note: Download the .zip file here or you can contact the support team by email at support@antsroute.com or by phone at +33 (0)3 72 74 49 71.

Go to “Plugins” > “Add New”.

Click on the “Upload Plugin” located at the top of the page.

Click on the “Choose file” button and select the file (.zip format) to upload from the computer.

Once the file name is displayed, click on the “Install Now” button.

Don’t forget to click on the blue “Activate” button.

Note: After having activated the AntsRoute plugin, it is then displayed in the “Settings” tab of the WooCommerce plugin.

Step 2: Create the “Number” and “Weight” capacities on AntsRoute

These capacities will allow you to manage the quantities (number of packages and weight) that can be transported by each vehicle during a route.

Go to the “Settings” module.

Click on the “Capacities” tab in the sidebar.

Click on the blue “Add” button in the top right-hand corner of the page.

Fill in the first capacity:

Name * : Number ;
Unit * : Unit ;
Validation mode * : Optional.

Note: Please follow the use of upper and lower case letters for “Number”.

Click on the blue “Save” button.

Click a second time on the blue “Add” button in the top right-hand corner of the screen.

Fill in the second capacity:

Name * : Weight ;
Unit * : Kg ;
Validation mode * : Optional.

Note: Please follow the use of upper and lower case letters for “Weight”.

Click on the blue “Save” button.

Step 3: Determine the capacities of vehicles

After having created the different capacities, you must define the quantities that can be transported by each vehicle in terms of weight and number of packages.

Go to the “Resources” module.

Click on the “Vehicles” tab in the sidebar.

From the table with the list of vehicles, click on “…” and “Edit” for the first vehicle.

In the “Capacity types” box, determine the “Number” and “Weight” capacities of this vehicle.

Click on the blue “Save” button.

Confirm the vehicle update by clicking on the blue “Confirm” button.

Note: Repeat this step for each vehicle.

Step 4: Create the “Description”, “Price” and “Reference” extra fields on AntsRoute

Go to the “Settings” module.

Click on the “Extra fields” tab in the sidebar.

Click on the blue “Add” button in the top right-hand corner of the page.

Fill in the first extra field:

Name *: Description ;
Linked to: Intervention/Rendez-vous ;
Display screen: Create/update screen ;
Field type: Text type.

Note: Please follow the use of upper and lower case letters for “Description”.

Click on the blue “Save” button.

Click a second time on the blue “Add” button in the top right-hand corner of the screen.

Fill in the second extra field:

Name *: Price ;
Linked to : Order/appointment ;
Display screen: Create/Update screen ;
Field type: Text type.

Note: Please follow the use of upper and lower case letters for “Price”.

Click on the blue “Save” button.

Click a third time on the blue “Add” button in the top right-hand corner of the screen.

Fill in the third extra field:

Name *: Reference ;
Linked to: Order/appointment ;
Display screen: Create/Update screen ;
Field type: Text type.

Note: Please follow the use of upper and lower case letters for “Reference”.

Click on the blue “Save” button.

Step 5: Get an AntsRoute API key

Go to the “API Key” tab from your profile.

Click on the blue “Add” button located in the top right-hand corner of the screen.

Select the site for which create an API key.

Click on the blue “Create” button.

Note : Copy the key generated and paste it in a secure document as it will be asked later when setting up the plugin in WordPress.

Note : After copying the key, you can paste it into a text file because you’ll need it when setting up the AntsRoute plugin on WordPress.

Click on the blue “Continue” button.

Note: If you lose the AntsRoute API key, you can create a new one at any time.

Step 6: Set up the AntsRoute module on WordPress

Go to “WooCommerce” > “Settings”.

Click on the AntsRoute tab located at the top of the page.

SET UP THE GENERAL SETTINGS

Click on “General settings”.

Choose the “Carrier”.

Select the “Delivery Trigger” among the following options:

Note : This is the WooCommerce action that triggers a delivery. As soon as this action is “validated” on WooCommerce, the delivery is scheduled on AntsRoute.

Pending payment ;
Processing ;
On hold ;
Completed ;
Cancelled ;
Refunded ;
Failed.

Select the “Cancel Trigger” among the options.

Note : This is the WooCommerce action that triggers a delivery cancellation. When this action is “validated” on WooCommerce, the delivery is cancelled on AntsRoute.

Paste the “API Key” created on AntsRoute during the previous step.

Define the tab for “Add in order” among the following options:

In the intervention basket ;
In the module organize.

Note: This is the tab from which the delivery is scheduled.

Click on the “Save changes” button in the bottom left-hand corner of the page.

SET UP THE DELIVERY SETTINGS

Click on “Delivery settings”.

Define the “Delivery deadline”, i.e. the number of working days between the order date and delivery date.

Note: The deadlines are expressed in working days with D corresponding to the day of the order.

Define the “Delivery time slots”.

Note: Check the boxes corresponding to the days for which you want to deliver to your customers. Indicate the “start” and “end” time for deliveries. For example, 08:00 – 17:00.

Define the “Delivery time” in minutes.

Note: Time required to deliver the goods to the customer.

Click on the blue “Save changes” button in the bottom left-hand corner.

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

For companies whose deliverymen carry out 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 ON ANTSROUTE

Go to the “Settings” module.

Click on the “Site settings” tab in the sidebar.

In “General settings”, check the “Enable pickup & delivery mode” box.

Click on the blue “Save” button.

ACTIVATE THE FEATURE ON WORDPRESS

Go to “WooCommerce” > “Settings” > “AntsRoute > “Pick-up & Delivery”.

“Enable pick-up & delivery” by selecting “Yes”.

Determine the “Warehouse name”.

Note: The warehouse is the place where the goods are loaded.

Determine the “Warehouse address”.

Determine the “Loading time”.

Note: The loading time is the time necessary to load the goods into the vehicles.

Determine the “Loading slot”.

Note: The loading slot is the same for each day of the week.

Click on the blue “Save changes” button located in the bottom left-hand corner.