Skip to main content
Create a location

Body

application/json
address
string
required
Minimum string length: 1
Example:

"357 allée des Tilleuls"

city
string
required
Minimum string length: 1
Example:

"Saint Quentin Fallavier"

country
string
required

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Za-z]{2}$
Example:

"FR"

additional_information
string
Example:

"Please avoid Friday after 4pm"

client_reference
string

Your own identifier for the location. Unique among the active locations of the account.

Minimum string length: 1
Example:

"WH-LYS-01"

name
string

Defaults to the city.

Example:

"Saint Quentin warehouse"

opening_hours
string
Example:

"Monday to Friday 8am to 5pm"

requires_appointment
boolean

Specifies if appointments are required for loading and unloading at this location.

requires_tailgate_truck
boolean

Specifies if liftgate trucks are required for this location.

state
string

State or province code.

Example:

"NY"

zip_code
string
Example:

"69300"

Response

The created location.

id
string
Example:

12345

company_name
string
Example:

"Logistics WorldWide Co"

name
string
Example:

"Saint Quentin warehouse"

client_reference
string

Your own identifier for the location.

Example:

"WH-LYS-01"

address
string
Example:

"357 allée des Tilleuls"

city
string
Example:

"Saint Quentin Fallavier"

zip_code
string
Example:

69300

state
string

State or province code.

Example:

"NY"

country
string
Example:

"FR"

contacts
object[]
opening_hours
string
Example:

"Monday to Friday 8am to 5pm"

requires_appointment
boolean

Specifies if appointments are required for loading and unloading at this location.

requires_tailgate_truck
boolean

Specifies if liftgate trucks are required for this location.

Example:

false

additional_information
string
Example:

"Please avoid Friday after 4pm"