---
title: "Inventory - Get Grouped Locations Map"
method: POST
path: "/inventory/get_grouped_locations_map"
tags: ["inventory"]
---

# Inventory - Get Grouped Locations Map

`POST /inventory/get_grouped_locations_map`

Retrieve inventory quantities grouped by location across warehouses.

## Request body

- object
  - `data` object, required — Query data object

## Response `200`

Inventory grouped by location or element. Returns an array by default, or a map when result_type is "map".

- union
  - GroupedLocationEntry[]
    - `_id` string, required — Group key (location_id or element_id depending on group_by)
    - `locations` object[], required — Location entries in the group
      - `location_id` string, required — Location identifier
      - `item_id` string, required — Item identifier
      - `on_hand` number, required — Quantity on hand
      - `alert` number — Alert threshold
  - object

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden. Insufficient permissions.
- `429` — Too many requests. Rate limit exceeded.
- `500` — Internal server error.

## Changes

- **2026-03-02** `fa53dd949b8e` — 1 breaking, 7 info
  - the request property `data` became required
  - api operation id `post_inventory_get_grouped_locations_map` was added
  - added the media type `application/json` for the response with the status `200`
  - added the media type `application/json` for the response with the status `400`
  - …4 more
- **2024-04-22** `08cd9cfa14dd` — 1 breaking, 1 warning, 2 info
  - added required request body
  - deleted the `query` request parameter `data`
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
- **2024-04-19** `46ceda528000` — 2 breaking, 7 info
  - removed the request body
  - removed the media type `application/json` for the response with the status `200`
  - api operation id `post_inventory_get_grouped_locations_map` removed and replaced with ``
  - added the new optional `query` request parameter `data`
  - …5 more

[Change history](https://skmtc.dev/skulabs/apis/skulabs-api/changes/inventory/get_grouped_locations_map/post.md)

---

[API](https://skmtc.dev/skulabs/apis/skulabs-api.md) · [All operations](https://skmtc.dev/skulabs/apis/skulabs-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/skulabs/skulabs-api/revisions/4b5ec0ed78a6/schema)