List bins

Operation ID: bins

Group: Inventory › Bins

Open in the interactive reference

GET /inventory/bins

Read-only: Reads and returns; changes nothing.

Lists bins. Each bin comes back with its layout, limits, and settings, but not capacity. Only GET inventory/bins/:id returns capacity.

Sort on aisle, rack, and shelfLevel to list the bins in warehouse layout order.

To find bins that have no capacity limit, use POST inventory/bins/search.

Parameters

Query surface

• id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• binCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• barcode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• locationId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• aisle — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• rack — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• zone — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• isPickingBin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• isReceivingBin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• isProductionBin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• capacityCheckMode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• tempZone — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• supportsPerishable — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• Orderable: id, binCode, aisle, rack, shelfLevel, active, lastModifiedDate
• Selectable: id, binCode, barcode, locationId, locationCode, locationName, aisle, rack, shelfLevel, zone, itemPosition, isPickingBin, isReceivingBin, isProductionBin, maxQuantity, maxWeight, maxWeightUnit, maxVolume, maxVolumeUnit, capacityCheckMode, tempZone, tempMin, tempMax, supportsPerishable, active, createdDate, lastModifiedDate
• page[size] — Page size
• page[cursor] — Opaque continuation cursor

Response

200 Success

Under data, an array of binsRow:

{
  "data": [
    {
      "id": "8e1c40a7-5b93-4d26-a0f8-3c74e19b5d02",
      "binCode": "A-01-1",
      "barcode": "BIN-A011",
      "locationId": "f5272ae0-0f0b-47d2-b78a-2158fec2cc32",
      "locationCode": "WH-02",
      "locationName": "Main warehouse",
      "aisle": "A",
      "rack": "01",
      "shelfLevel": "1",
      "zone": "Picking",
      "itemPosition": "<itemPosition>",
      "isPickingBin": true,
      "isReceivingBin": true,
      "isProductionBin": true,
      "maxQuantity": 500,
      "maxWeight": "250",
      "maxWeightUnit": "Kg",
      "maxVolume": "19.99",
      "maxVolumeUnit": "<maxVolumeUnit>",
      "capacityCheckMode": "HardBlock",
      "tempZone": "Ambient",
      "tempMin": "19.99",
      "tempMax": "19.99",
      "supportsPerishable": true,
      "active": true,
      "createdDate": "2026-01-15T09:30:00.000Z",
      "lastModifiedDate": "2026-08-18T09:14:22.517Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses

• 400 — Invalid request or business failure
• 401 — The request carries no valid access token.
• 403 — Not authorized
• 404 — Not found
• 429 — Too many requests from this client address. The response has no body and no Retry-After header.
• 500 — Internal server error