v1

latestOpenAPI 3.0.02026-08-061380344.2 KB
Warehouses

Create a Warehouse

Create a warehouse / storage location

Parameters

name REQUIRED

The name or primary label for your warehouse or storage location


internal_id OPTIONAL

Custom ID you use to identify this record


track_capabity OPTIONAL

Boolean value to determine if the warehouse tracks different shelves or bins to store different items OR is treated as a single container like a tank or silo.

If enabled, retrieving a warehouse will include its current amount available.


capacity OPTIONAL

If tracking capcity in the warehouse (not bins) - a numeric value to determine the total storage amount available based on unit.


unit OPTIONAL

If tracking capcity in the warehouse, the unit used for inventory is stored.

"Bales", "Barrels", "Bunches", "Bushels", "Dozen", "Fluid Ounces", "Gallons", "Grams", "Head", "Kilograms", "Kiloliter", "Liter", "Milliliter", "Ounces", "Pounds", "Quantity", "Quarts", "Tonnes", "Tons"

Defaults to Quantity


description OPTIONAL

Text description or summary of the warehouse. Can be used to communicate location or other identification information to your team members.

post/warehouses

Headers

Content-Typestring

Request body

object required

Example request

{
  "description": "Alien warehouse",
  "internal_id": "A51",
  "name": "Area 51",
  "track_capacity": false,
  "capacity": 0,
  "unit": null
}

Response

Successful response