Skip to main content

​
Overview

This endpoint can be used to create a new address. Endpoint: /api/v1/addresses Method: POST
It is critically important that you verify the address before creating it.Failure to verify the address may result in loss or delayed shipments.You may also be charged should address correction be necessary by the carrier.

​
Request

​
name
string
required
For example, “John Smith” or “Acme Products”.Minimum character length: 2Maximum character length: 50
​
email
string
required
The contact email address.Carriers may send one or more shipment tracking notifications to this email address.Minimum character length: 6Maximum character length: 100
​
phone
string
required
The contact phone number.This must be formatted using the E.164 standard.Minimum character length: 7Maximum character length: 30
​
line_1
string
required
Line 1 of the address.Minimum character length: 2Maximum character length: 35
​
line_2
string
Line 2 of the address.Minimum character length: 2Maximum character length: 35
​
city
string
required
The address’ town or city.Minimum character length: 2Maximum character length: 35
​
region
string
required
The address’ state, province, or region.Minimum character length: 2Maximum character length: 30
​
post_code
string
required
The address’ post code.Minimum character length: 2Maximum character length: 16
​
country
integer
required
A Country enum representing the address’ country.

​
Response

If the address is successfully created, the API will return a 201 Created status code. The response will contain the following content:
​
id
integer
required
The ID of the newly created address.
{
    "name": "Kohler Group",
    "email": "parisian.kristoffer@yahoo.com",
    "phone": "+12069536978",
    "line_1": "193 Dach Shores Suite 632",
    "line_2": "Apt. 300",
    "city": "Moenburgh",
    "region": "Colorado",
    "post_code": "72099",
    "country": 1,
}

{
    "id": 10012
}