Skip to main content
POST
Create a warehouse

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

application/json
name
string
required

The name.

Maximum string length: 255
code
string | null

The unique code.

Maximum string length: 255
description
string | null

The description.

country_id
integer | null

The country ID.

city_id
integer | null

The city ID.

district_id
integer | null

The district ID.

postal_code
string | null

The postal code.

Maximum string length: 20
Pattern: ^\d+$
address
string | null

The street address.

Maximum string length: 1000
latitude
number | null

The latitude.

longitude
number | null

The longitude.

contact_fullname
string | null

The contact fullname.

Maximum string length: 255
contact_email
string<email> | null

The contact email.

Maximum string length: 255
contact_phone
string | null

The contact phone.

Maximum string length: 255
is_active
boolean

Whether the record is active.

is_default
boolean

Whether the record is the default.

Response

success
string
required
data
WarehouseResource · object
required