Skip to main content
GET
/
warehouses
Listar depósitos do tenant
curl --request GET \
  --url https://api.example.com/warehouses
{
  "data": [
    {
      "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
      "name": "Armazém Central SP",
      "code": "SP-01",
      "isDefault": true,
      "active": true
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}

​
Query Parameters

​
page
number
default:"1"
Paginação atual.
​
limit
number
default:"10"
Quantidade de itens por página indicados.
​
search
string
Busca por nome comercial ou código interno (alias) do depósito.
​
active
boolean
Filtra por status (true para ativos, false para inativos).

​
Response

{
  "data": [
    {
      "id": "e4b6d4e8-8e6d-41da-abdb-8fc358a9e7f1",
      "name": "Armazém Central SP",
      "code": "SP-01",
      "isDefault": true,
      "active": true
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}

Query Parameters

​
companyId
string

Filtrar por empresa

​
type
enum<string>

Filtrar por tipo

Available options:
OWN,
STORE,
FULFILLMENT,
THIRD_PARTY
​
isActive
boolean

Filtrar por status ativo/inativo

​
search
string

Busca por nome ou código

Response

200

Lista de depósitos