Skip to main content
GET
/
v1
/
inventory
/
groups
/
{locationCode}
Get inventory group
curl --request GET \
  --url http://localhost:3000/v1/inventory/groups/{locationCode}
{
  "children": [
    "<unknown>"
  ],
  "inventory": [
    "<unknown>"
  ],
  "totals": {
    "total_quantity": 123,
    "reserved_quantity": 123,
    "available_quantity": 123,
    "item_count": 123
  },
  "group": "<unknown>"
}

Path Parameters

locationCode
string
required

Location code or UUID

Example:

"A-01-01-01-01"

Response

Inventory group details

children
null[]
required
inventory
null[]
required
totals
object
required
group
unknown