Skip to main content

Bulk Generate Warehouse Locations

POST 
/api/v2/warehouse-locations/bulk-generate

Generate a range of locations from segment patterns. With preview: true the response returns {codes_sample, total, conflicts} without persisting; otherwise the non-conflicting codes are inserted and the response returns {created, skipped_codes}.

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

Body fields:

  • warehouse_id (required, integer, exists)
  • type (required, enum: staging, primary_pick, reserve, storage, shipping, returns, quarantine, damaged)
  • Generated bins seed their capability flags (is_receivable, is_pickable, is_putaway_source, is_putaway_destination) from the chosen type; adjust per bin afterwards via Update.
  • zone (nullable, string max 32)
  • segments (required array, 1-6 items). Each segment:
    • kind (required, one of: literal | letters | numbers)
    • value (required when kind=literal, string max 32)
    • from / to (required unless kind=literal) — range bounds
    • pad (boolean) — zero/left pad range values to equal width
  • preview (boolean) — dry-run without persisting

Requires permission: warehouses.manage_locations

Request​

Responses​

OK