Addresses

When creating a Job or Delivery we require that you send through accurate pickup and dropoff addresses. It goes without saying that accurate addresses form a pivitol part of successful deliveries. With that in mind, below are some tips to help you get it right.

Format

Both pickup and dropoff addresses follow the same schema detailed below. only the field prefix changes e.g. pickup_address1, dropoff_address1.

Field NameDescription
address1Street name and number.
address2Flat number, floor, building name, unit, etc. (all address components other than street name and number)
cityCity
postcodePostcode
country_codeSee ISO_3166-1
w3wWhat3words

Geocoding

The following fields are used for geocoding (converting the address into coordinates):

  • address1
  • city
  • postcode
  • country_code

The address2 field is only used as additional information for the courier.

To avoid geocoding errors please make sure that only street name and number is submitted in the address1 field.

If you are exposing these fields via a form to be completed by end users, we recommend you label them as follows to avoid confusion:

  • address1 field as: "Street name and number" (correct address details required for geocoding),
  • address2 field as: "Building name/floor/flat" (that suggests where this information should be entered and prevents them adding it in the 1st field).

What3words can be used as an alternative geocoding method. If provided - it has priority over standard approach above.