---
title: "List storage locations"
method: GET
path: "/api/v1/warehouses/{warehouseId}/storageLocations"
tags: ["Storage Location"]
---

# List storage locations

`GET /api/v1/warehouses/{warehouseId}/storageLocations`

## Request

- Base URL: `https://xentral.xentral.biz`
- URL: `https://xentral.xentral.biz/api/v1/warehouses/{warehouseId}/storageLocations`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xentral/apis/xentral-api/docs/api/v1/warehouses/:warehouseId/storageLocations/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint is only available as beta version and will introduce breaking changes without further notice or versioning. Returns all storage locations for the specified warehouse.

## Path parameters

- `warehouseId` string, required: Resource identifier.

## Query parameters

- `page` object
  - `number` string, required: Page number should be an integer greater than or equal to 1
  - `size` string, required: Page size should usually be an integer between 10 and 50.
- `filter` object[]
  - `key` 'storageLocationId' | 'designation'
  - `op` 'equals' | 'notEquals' | 'in' | 'notIn' | 'exactlyIn' | 'allIn' | 'allNotIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' | 'greaterThan' | 'lessThan' | 'is' | 'lessThanOrEquals' | 'greaterThanOrEquals'
  - `value` union
    - string: Used for the operations 'equals', 'notEquals', 'contains', 'notContains', 'startsWith', 'endsWith' and 'is'.
    - string[]: Used for the operations 'in', 'notIn', 'exactlyIn', 'allIn' and 'allNotIn'.

## Response `200`

Operation completed successfully.

- object
  - `data` object[]: Representation of a list of Storage Locations
    - `id` string, required: Resource identifier.
    - `warehouse` object, required: Reference to another resource
      - `id` string, required: Resource identifier.
    - `designation` string, required: Designation of the Storage location
    - `description` string: Description of the Storage location
    - `project` object, nullable: Nullable reference to another resource
      - `id` string, required: Resource identifier.
    - `sort` integer: Sort order of the storage location
    - `isReplenishmentLocation` boolean: Indicates if the location is for replenishment
    - `isConsumptionLocation` boolean: Indicates if the location is for consumption
    - `isRestrictedLocation` boolean: Indicates if the location is restricted
    - `productionAccess` boolean: Indicates if the location has production access
    - `isPosLocation` boolean: Indicates if the location is a point of sale location
    - `abcCategory` string: ABC category of the storage location
    - `dimensions` object: Dimensions of the storage location
      - `length` number, float: Length of the storage location
      - `width` number, float: Width of the storage location
      - `height` number, float: Height of the storage location
  - `extra` object
    - `totalCount` integer, required: the total count of all items
    - `page` object, required: The pagination object containing the current page number and size
      - `number` integer, required: The current page number
      - `size` integer, required: The size of the pages

## Other responses

- `400`: IETF RFC 9457 Problem API compliant response
- `401`: Unable to authenticate the client
- `403`: Unable to authorize the client
- `404`: Resource was not found or not enough access privileges
- `406`: Requested resource representation does not exist.
- `429`: Too many API calls made.

---

[API](https://skmtc.dev/xentral/apis/xentral-api.md) - [All operations](https://skmtc.dev/xentral/apis/xentral-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xentral/apis/xentral-api/revisions/ebe5ba2a4ed8?raw)