Location - AfterShip Commerce API

The Location Model signifies the physical premises of your store as registered within the AfterShip system. You can use the location_id to uniquely identify this location.

location_id

string

The unique identifier for the location, as provided by AfterShip. You can manage and configure these locations here.

Example:

489b4bdec18d45d387752d63fb51ee1d

address

Address

The addess object of this location.

Example:

{"type":"business","street_1":"1234 Elm Street","street_2":"Apt 5","street_3":null,"city":"New York","state":"NY","postal_code":"10001","country_region":"USA","company":"My Company","first_name":"John","last_name":"Doe","email":"[email protected]","phone":"+13525554500"}

type

string

The type of address.

Allowed values:

businessresidential

street_1

string

required

First line of the street address.

<= 256 characters

street_2

string or null

Second line of the street address.

<= 256 characters

street_3

string or null

Third line of the street address.

<= 256 characters

city

string

The location's city, town, or village.

<= 256 characters

state

string

required

The state or region of the location, such as a province, state, or prefecture.

<= 256 characters

postal_code

string

The postal code of the location (also known as zip code, postcode, Eircode, etc.).

<= 256 characters

country_region

string

required

The address country/region in ISO 3166-1 alpha-3 format. API will automatically convert input to uppercase.

Example:

USA

Match pattern:

^[A-Z]{3}$

company

string

The name of the company associated to the address.

<= 256 characters

first_name

string

The first name of the person associated to the address.

<= 256 characters

last_name

string

The last name of the person associated to the address.

<= 256 characters

string

The email address of the person associated to the address.

<= 256 characters

phone

string

The phone number of the person associated to the address.

<= 256 characters