Terminal Shipping API
Ask or search…
K

Create Address

Create an address for getting rates or arranging pickup and delivery.
post
https://api.terminal.africa
/v1/addresses
/addresses
This endpoint allows you to add a new address to your account.
Parameters
Header
Authorization*
String
Set value to Bearer SECRET_KEY
Content-Type
String
Set value to application/json
Body
city*
String
Address city.
state*
String
Address state
country*
String
ISO 2 country code for address.
email
String
Email of person at address.
first_name
String
First name of person at address. Required for arranging pickup / delivery.
is_residential
Boolean
Indicates if address is a residential address or not. Defaults to true.
last_name
String
Last name of person at address. Required for arranging pickup / delivery.
line1
String
Street address. Required for arranging pickup / delivery.
line2
String
Second line of street address.
metadata
Object
Additional information for an address.
name
String
Full name of person at address.
phone
String
Phone number of person at address. Required for arranging pickup / delivery.
zip
String
Zip / Postal code. Required for arranging pickup / delivery.
Responses
200
Address created successfully.