Skip to main content
GET
/
v1
/
inventory
/
groups
List inventory groups
curl --request GET \
  --url http://localhost:3000/v1/inventory/groups
{
  "groups": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "location_code": "<string>",
      "zone_code": "<string>",
      "aisle_number": 123,
      "bay_number": 123,
      "shelf_number": 123,
      "slot_number": 123,
      "parent_group_id": "<string>",
      "is_active": true,
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>"
    }
  ]
}

Query Parameters

type
enum<string>
default:all

Filter by group type

Available options:
aisle,
bay,
shelf,
slot,
all
Example:

"slot"

zone
string

Filter by zone code

Example:

"A"

aisle
integer | null

Filter by aisle number

Example:

1

parent_id
string<uuid>

Filter by parent group ID

Response

200 - application/json

List of inventory groups

groups
object[]
required