---
title: "Query Warehouses"
method: GET
path: "/v2/warehouses"
tags: ["warehouse"]
---

# Query Warehouses

`GET /v2/warehouses`

Query all warehouses

## Query parameters

- `isActive` boolean
- `pageNumber` integer
- `pageSize` integer

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Response `200`

Returns all warehouses.

- JTLWawiRestContractsModelsPagedListOfJTLWawiRestContractsModelsV1WarehouseWarehouse — Represents a paginated list of items
  - `totalItems` integer — Gets or sets the total number of items available in the data source.
  - `pageNumber` integer — Gets or sets the current page number in the paginated list.
  - `pageSize` integer — Gets or sets the number of items per page in the paginated list.
  - `items` JTLWawiRestContractsModelsV1WarehouseWarehouse[] — Gets or sets the collection of items contained in the paged list.
    - `id` string, uuid
    - `name` string — Name of the warehouse.
    - `address` JTLWawiRestContractsModelsV1CommonAddress — Model Class: Address
      - `id` string, uuid
      - `company` string — Description of the Company.
      - `company2` string — Additional company information
      - `formOfAddress` string — Customer form of address
      - `title` string — Official title
      - `firstName` string — Customer first name
      - `lastName` string — Customer last name
      - `street` string — Street name in the customer's address
      - `address2` string — Additional address information
      - `postalCode` string — Postal code of the customer's address
      - `city` string — Name of city in the customer's address
      - `state` string — Name of state in the customer's address
      - `countryIso` string — Country ISO code
      - `vatID` string — Supplier VAT ID number
      - `phoneNumber` string — Landline phone number
      - `mobilePhoneNumber` string — Mobile phone number
      - `emailAddress` string — Email address
      - `fax` string — Fax number
    - `code` string — Code of the warehouse.
    - `type` JTLWawiRestContractsModelsV1WarehouseWarehouseType — Model Class: WarehouseType
      - `id` string — Unique Id of the warehouse type as UUID.
      - `name` string — Name of the warehouse type.
      - `description` string — Description of the warehouse type.
      - `scope` string[] — List of Scopes with permissions
    - `description` string — A description on the warehouse.
    - `priority` integer — Priority level of the warehouse.
    - `companyId` string, uuid — Represents a key for identifying a firm within the application.
    - `lockForShipment` boolean — Indicates if the warehouse is locked for shipment.
    - `lockForAvailability` boolean — Indicates if the warehouse is locked for stock availability.
    - `isActive` boolean — Indicates if the warehouse is active.
  - `totalPages` integer — Gets the total number of pages based on the total number of items and the page size.
  - `hasPreviousPage` boolean — Gets a value indicating whether there is a previous page available in the paginated list.
  - `hasNextPage` boolean — Gets a value indicating whether there is a next page available.
  - `nextPageNumber` integer — Gets the number of the next page if there is one; otherwise, returns the total number of pages.
  - `previousPageNumber` integer — Gets the number of the previous page. If there is no previous page, it returns 1.

## Other responses

- `401`
- `402` — No licence available or the app has not been authorised by JTL.

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/revisions/f979b1ea6951/schema)