Addresses

The Addresses API allows you to create and manage pickup and delivery locations.

The Address Object
This section describes the different attributes available for an address.
Attribute
Type
Description
address_id
string
Unique reference for address.
city
string
Valid address city.
coordinates
object
Geo coordinates for address.
coordinates.lat
number
Latitude for address coordinates
coordinates.lng
number
Longitude for address coordinates
country
string
ISO 2 country code for address. e.g. NG
email
string
Email of person at address.
first_name
string
First name of person at address.
is_residential
boolean
Indicates if address is a residential address or not.
last_name
string
Last name of person at address.
line1
string
Street address.
line2
string
Second line of street address.
metadata
object
Provide additional information for an address.
name
string
Full name of person at address.
phone
string
International phone number for person at address. Must match country provided.
place_id
string
Unique google place id for address location.
state
string
Valid address state.
zip
string
Zip / Postal code for address.
created_at
datetime
Time address created.
updated_at
datetime
Time address last updated.

Errors

Create Address

Last modified 6mo ago

Attribute	Type	Description
address_id	string	Unique reference for address.
city	string	Valid address city.
coordinates	object	Geo coordinates for address.
coordinates.lat	number	Latitude for address coordinates
coordinates.lng	number	Longitude for address coordinates
country	string	ISO 2 country code for address. e.g. NG
email	string	Email of person at address.
first_name	string	First name of person at address.
is_residential	boolean	Indicates if address is a residential address or not.
last_name	string	Last name of person at address.
line1	string	Street address.
line2	string	Second line of street address.
metadata	object	Provide additional information for an address.
name	string	Full name of person at address.
phone	string	International phone number for person at address. Must match country provided.
place_id	string	Unique google place id for address location.
state	string	Valid address state.
zip	string	Zip / Postal code for address.
created_at	datetime	Time address created.
updated_at	datetime	Time address last updated.