Skip to main content
POST
Create Warehouse

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Body

application/json

An object conforming to the Warehouse schema to be created.

A Warehouse represents a physical location from which you can store inventory and perform operations independently of other warehouses.

name
string

The display name for the Warehouse.

Maximum string length: 255
Example:

"East Coast 1"

abbreviation
string | null

A short abbreviation for the Warehouse, up to 10 characters. Recommended to be fewer than 6 characters.
Optional Field

Maximum string length: 10
Example:

"EC1"

is_active
boolean

This flag determines if the Warehouse is active and viable for fulfillment.

Example:

true

Response

Created - The resource was created successfully.

resource
object

An object describing the resource that was created.

meta
object