v1

latestOpenAPI 3.0.02026-08-061380344.2 KB

Warehouses > Bins

Create a Warehouse Bin

Create a warehouse bin

Parameters

name REQUIRED

The name or primary label you want to use to identify this bin

capacity OPTIONAL

Numeric value of the total amount that can be stored this the bin, in the unit of the bin

description OPTIONAL

Text description or summary of the bin. This can be useful to communicate the location or other important details to team members.

internal_id OPTIONAL

A customer or internal ID that you use to track this bin.

unit OPTIONAL

The unit used for inventory is stored in this bin.

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

Defaults to Quantity

post/warehouses/{warehouse_id}/bins

Path parameters

warehouse_idstring required

Headers

Content-Typestring

Request body

object required

Example request

{
  "capacity": 100,
  "description": "Bin for API tests",
  "internal_id": "api",
  "name": "API Bin",
  "unit": "tons"
}

Response

Successful response