<aside> 💡 In order to capture what3words addresses, you will first need to enable the field from your Address Profile. A guide on this can be provided upon request from [email protected]

</aside>

API Key Sign-up Process

Before you get started, you will need to create a what3words API key by following these instructions to use it within NetCourier.

1. Select an API plan
2. Login or signup for a what3words developer account.
3. Specify the name of your business and the software platform that you are integrating what3words into.
4. Select Generate API Key.
5. Provide Metafour with your API key

Screenshot 2022-10-21 at 10.06.19.png

Find out more about the what3words API on our what3words developer site

How to input and pass through a what3words address to NetCourier?

Here is a step-by-step guide for inputting and passing through a what3words address to NetCourier in the different available formats:

In order to capture what3words addresses, you will first need to enable the field from your Address Profile. A guide on this can be provided upon request from [email protected]

1. Uploading/passing through a what3words address directly from API

To provide a what3words address via the API, you will need to populate the what3words parameter in the request body. This can be found as part of the collectionAddress, deliveryAddress & billThirdPartyAddress objects.

Here’s an example:

1. Manually creating orders within NetCourier with a what3words address

When opening the Address Modal from any of our screens, you will see the what3words address field below Postcode.

This field is a search-suggest, if you know the what3words address, you can simply start typing and it will provide a list of valid options based on your search string.

If you are unsure, you can click the what3words icon and it will load the what3words map screen, allowing you to select the square visually. Click the ‘Select place’ button and this will store the relevant what3words against that address record.