---
title: "List warehouses"
method: GET
path: "/api/v1/sa/inventory/warehouses"
tags: ["Warehouses"]
---

# List warehouses

`GET /api/v1/sa/inventory/warehouses`

## Request

- Base URL: `https://app.sellerassistant.app` (the document declares no server; this is the origin it was published from)
- URL: `https://app.sellerassistant.app/api/v1/sa/inventory/warehouses`
- Auth: one of:
  - API key in query parameter `api_key`
  - API key in header `X-Api-Key`

The list holds the warehouses of the team and the shared ones. A shared warehouse is read only.

## Query parameters

- `search` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

One page of the warehouses

- object
  - `data` Warehouse[]
    - `id` integer
    - `name` string
    - `website` string, nullable
    - `location` string, nullable
    - `contacts` string, nullable
    - `config` object, nullable
    - `status` string, nullable
    - `is_primary` boolean: One team has one primary warehouse.
    - `is_shared` boolean: A shared warehouse is read only for the team.
    - `provider` string, nullable: The prep provider the warehouse syncs with.
    - `is_synced` boolean
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `meta` object
    - `pagination` ApiV1Pagination: The page the answer carries. Every list of the v1 answers it under `meta`.
      - `page` integer: The schemas every endpoint of the public API v1 shares. The envelope is the same on every endpoint, so it lives here once. An endpoint points at it with a `$ref`, and the generated collection stays small and consistent. The parameters live in ApiV1Parameters, not here. swagger-php drops the class level `OA\Schema` attributes of a class that also carries a class level `OA\Parameter`, so the two kinds need two classes. This class holds no code. swagger-php reads the attributes, and nothing calls it.
      - `per_page` integer
      - `total` integer
      - `last_page` integer
    - `trial_limit` ApiV1TrialLimit: Present only on trial, when the trial hides rows of the list. The trial shows the first rows of a list, and the pagination counts only these rows.
      - `max_rows` integer: The number of rows that the trial shows.
      - `total` integer, nullable: The true number of rows in the list. It is null for a list that does not count its rows.
      - `code` string
      - `message` string
      - `subscribe_url` string, uri

## Other responses

- `400`: Bad request - validation failed or invalid parameters
- `403`: Access denied - insufficient permissions, invalid API key, or the API request limit is used up (`public_api_key_limit`)
- `429`: Too many requests - rate limit exceeded

---

[API](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api.md) · [All operations](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sellerassistant/apis/seller-assistant-public-api/revisions/5b3ecdbcadb6?raw)