Add Address

Add a new address to your system's address book. With this endpoint, you can create a new address and submit the necessary details of that address, enabling the system to store the information in the Address Book for later use in the Create Shipment requests.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Address Book details

Add Address Book

string | null

A unique identifier for each address record. This information ensures that each address can be distinctly referenced and managed within the system.

string | null

The name of the primary contact associated with the address. This field is essential for identification and communication purposes.

string | null

The name of the company linked to the address. This field provides context for the address, especially in business-related queries.

string | null

The email address of the primary contact for the address. This is used for correspondence and can facilitate communication directly related to the address.

string | null

The phone number of the primary contact associated with the address. This field is crucial for any immediate communication needs.

string
required
length between 1 and 50

The first line of the address, typically containing the primary address information such as house number and street name.

string | null

An optional second line for the address, often used for additional details like apartment numbers or suite designations.

string | null

A third optional line in the address to include any further address specifications, allowing for more detailed address information if necessary.

string
required
length between 1 and 50

The town or city, indicating the specific locality where the address is located.

string | null

The postal or ZIP code corresponding to the address, used to identify specific geographic areas.

string | null

The county, state, or province in which the address is located, providing additional geographical context for the address.

string
required
length between 2 and 2

An abbreviation representing the country of the address, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom.

string | null

A three-word location identifier provided by the What3words service, offering a precise way to define addresses using a unique combination of three words, for example, the front door of 10 Downing Street in London is identified by slurs.this.shark.

Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json