Locations

A location is a bin or spot within a warehouse where inventory is stored. Each location has a unique spot code.

The Location Object

{
  "spot": "A-01-03",
  "warehouseID": 1,
  "warehouseName": "Main",
  "description": "Aisle A, Row 1, Bin 3",
  "hold": false,
  "active": true
}

List Locations

GET /Location

Returns all locations with standard pagination parameters. Filter by warehouse using the optional wid parameter.

GET /Location?wid=1&page=1&pageSize=50

{
  "value": [
    {
      "spot": "A-01-03",
      "warehouseID": 1,
      "warehouseName": "Main",
      "description": "Aisle A, Row 1, Bin 3",
      "hold": false,
      "active": true
    },
    {
      "spot": "B-02-07",
      "warehouseID": 1,
      "warehouseName": "Main",
      "description": "Aisle B, Row 2, Bin 7",
      "hold": true,
      "active": true
    }
  ],
  "totalCount": 240,
  "page": 1,
  "pageSize": 50,
  "pageCount": 5,
  "hasMore": true
}

Get a Location

GET /Location/{spot}

Returns 404 if the spot code does not exist.

GET /Location/A-01-03

{
  "spot": "A-01-03",
  "warehouseID": 1,
  "warehouseName": "Main",
  "description": "Aisle A, Row 1, Bin 3",
  "hold": false,
  "active": true
}

Hold a Location

POST /Location/Hold?id={spot}

Places a location on hold. Inventory at this location cannot be moved or issued until released. Returns 204 on success.

POST /Location/Hold?id=A-01-03

Release a Location

POST /Location/Release?id={spot}

Releases a held location, restoring normal operations. Returns 204 on success.

POST /Location/Release?id=A-01-03

Permissions