PRproshipping
Address Book

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.

post/v4/addresses

Request

  • Base URL
    https://api.proshipping.net
  • URL
    https://api.proshipping.net/v4/addresses
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.proshipping.net/connect/token

Request body

AddressIdstring nullable

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

ContactNamestring nullable

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

CompanyNamestring nullable

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

ContactEmailstring email nullable

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

ContactPhonestring tel nullable

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

Line1string required

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

Line2string nullable

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

Line3string nullable

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

Townstring required

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

Postcodestring nullable

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

Countystring nullable

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

CountryCodestring required

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

What3Wordsstring nullable

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.

Example request

{
  "AddressId": "John Brown Default",
  "ContactName": "Jane Doe",
  "CompanyName": "My Company Ltd.",
  "ContactEmail": "jane@example.com",
  "Line1": "10 Sky Lane",
  "CountryCode": "GB",
  "What3Words": "brick.space.employ"
}

Response

The address book was added successfully.

AddressIdstring nullable

A unique identifier for each address record assigned by the system. This information ensures that each address is distinctly referenced and managed within the system.

Example response

{
  "AddressId": "93f6d928-9456-434a-9d69-60f3b7dea091"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.