Skip to main content

Create Warehouse Location

POST 
/api/v2/warehouse-locations

Create a single warehouse location (bin). Provide either an explicit code or at least one of the segment fields (zone, aisle, bay, shelf, bin) from which a code is derived.

Required scope: warehouses:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Scope: warehouses (read/write).

Body fields:

  • warehouse_id (required, integer, exists) — parent warehouse
  • code (string max 64, required_without_all:zone,aisle,bay,shelf,bin)
  • name (nullable, string max 255)
  • zone (nullable, string max 32)
  • aisle / bay / shelf / bin (nullable, string max 255)
  • type (required, enum: staging, primary_pick, reserve, storage, shipping, returns, quarantine, damaged)
  • is_receivable (optional, boolean) — bin can receive stock on inbound receipts
  • is_pickable (optional, boolean) — bin is eligible for order picking
  • is_putaway_source (optional, boolean) — stock can be drawn from this bin during put-away
  • is_putaway_destination (optional, boolean) — stock can be put away into this bin When a capability flag is omitted it is seeded from the location type defaults; once set, receiving, picking and put-away routing follow the flags, not the type.
  • barcode (nullable, string max 64)
  • sort_order (nullable, integer min 0)
  • is_default (boolean)
  • is_sellable (optional, boolean) — on-hand here counts toward available-to-sell
  • capacity_qty (optional, nullable, numeric min 0) — capacity in units; null = unbounded
  • abc_class (optional, nullable, one of A, B, C) — velocity class the bin is slotted for
  • replenish_min_qty (optional, nullable, numeric min 0) — Primary Pick only. When the bin's on-hand of a product drops below this, the bin appears on the replenishment queue
  • replenish_max_qty (optional, nullable, numeric min 0) — Primary Pick only. Refill target; must be >= replenish_min_qty and requires it. When null, refills target the minimum
  • replenish_round_qty (optional, nullable, numeric > 0) — Primary Pick only. Suggested refill quantities round up to a multiple of this (e.g. a case pack); requires replenish_min_qty Replenishment thresholds sent for any type other than primary_pick are rejected with 422. Changing a location's type away from primary_pick clears its thresholds.

Returns 201 with the created location; 422 if the tenant does not have locations enabled or the code/barcode conflicts.

Requires permission: warehouses.manage_locations

Request​

Responses​

Created