Skip to content

Create a Warehouse

POST
/warehouses

Create a new warehouse with the specified details.

object
warehouse
required
object
name

The name of the warehouse.

string
address_line_1

The first line of the warehouse address.

string
address_line_2

The second line of the warehouse address.

string
city

The warehouse’s city.

string
region

The warehouse’s state or county.

string
country

The warehouse’s country.

string
post_code

The warehouse’s postal/ZIP code.

string
phone

The warehouse’s phone number, if applicable.

string
cut_off_times_enabled

Whether cut-off times are enabled for this warehouse.

boolean
cut_off_times

Cut-off times for the warehouse.

object
default
object
monday
string format: time
tuesday
string format: time
wednesday
string format: time
thursday
string format: time
friday
string format: time
saturday
string format: time
sunday
string format: time
Example
{
"warehouse": {
"properties": {
"id": 123,
"name": "My Warehouse",
"address_line_1": "221 High Street",
"address_line_2": "Floor 4",
"city": "Swansea",
"region": "Glamorgan",
"country": "GB",
"post_code": "SA1 1NW",
"phone": "01792 720740",
"cut_off_times_enabled": true,
"cut_off_times": {
"default": {
"monday": "18:00",
"tuesday": "13:00",
"wednesday": "15:00",
"thursday": "19:00",
"friday": "13:00",
"saturday": "",
"sunday": ""
}
}
}
}
}

The warehouse was successfully created.

object
name

The name of the warehouse.

string
address_line_1

The first line of the warehouse address.

string
address_line_2

The second line of the warehouse address.

string
city

The warehouse’s city.

string
region

The warehouse’s state or county.

string
country

The warehouse’s country.

string
post_code

The warehouse’s postal/ZIP code.

string
phone

The warehouse’s phone number, if applicable.

string
cut_off_times_enabled

Whether cut-off times are enabled for this warehouse.

boolean
cut_off_times

Cut-off times for the warehouse.

object
default
object
monday
string format: time
tuesday
string format: time
wednesday
string format: time
thursday
string format: time
friday
string format: time
saturday
string format: time
sunday
string format: time
Example
{
"id": 123,
"name": "My Warehouse",
"address_line_1": "221 High Street",
"address_line_2": "Floor 4",
"city": "Swansea",
"region": "Glamorgan",
"country": "GB",
"post_code": "SA1 1NW",
"phone": "01792 720740",
"cut_off_times_enabled": true,
"cut_off_times": {
"default": {
"monday": "18:00",
"tuesday": "13:00",
"wednesday": "15:00",
"thursday": "19:00",
"friday": "13:00",
"saturday": "",
"sunday": ""
}
}
}

Bad Request. Check that you have included the minimum required fields - address line 1, city, region, country, and post code.