Skip to main content
POST
/
api
/
warehouses
Create a warehouse
curl --request POST \
  --url https://api.example.com/api/warehouses \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "name": "<string>",
  "primary": true,
  "code": "<string>",
  "address": "<string>",
  "city": "<string>",
  "country": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "website": "<string>"
}
'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
name
string
required

The name of the warehouse

​
primary
boolean
required

Whether the warehouse is primary

​
code
string
required

The code of the warehouse

​
address
string
required

The address of the warehouse

​
city
string
required

The city of the warehouse

​
country
string
required

The country of the warehouse

​
phoneNumber
string
required

The phone number of the warehouse

​
email
string
required

The email of the warehouse

​
website
string
required

The website of the warehouse

Response

201 - undefined