Comércios
Listar Comércios
Obtenha uma lista paginada de comércios com filtros.
GET /api/commerces
Retorna uma lista paginada de comércios com filtros opcionais.
Auth: Obrigatória — permissão commerce:manage
Headers
| Header | Obrigatório | Valor |
|---|---|---|
Authorization | Sim | Bearer <access_token> |
x-tenant-id | Sim | UUID do tenant |
Parâmetros de Consulta
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | number | 1 | Número da página |
per_page | number | 25 | Itens por página (máx. 100) |
search | string | - | Buscar por nome ou ID externo |
external_id | string | - | Filtrar por ID externo |
global_external_id | string | - | Filtrar por ID externo global |
is_active | boolean | - | Filtrar por status ativo |
is_placeholder | boolean | - | Filtrar por status placeholder |
Exemplo
curl "https://api.reten.ai/api/commerces?page=1&limit=10&search=main" \
-H "Authorization: Bearer <token>" \
-H "x-tenant-id: <tenant-id>"const params = new URLSearchParams({ page: "1", limit: "10", search: "main" });
const response = await fetch(`https://api.reten.ai/api/commerces?${params}`, {
headers: {
"Authorization": "Bearer <token>",
"x-tenant-id": "<tenant-id>",
},
});
const data = await response.json();import requests
response = requests.get(
"https://api.reten.ai/api/commerces",
headers={
"Authorization": "Bearer <token>",
"x-tenant-id": "<tenant-id>",
},
params={"page": 1, "limit": 10, "search": "main"},
)
data = response.json()Resposta 200 OK
{
"data": [
{
"id": "880e8400-e29b-41d4-a716-446655440000",
"name": "Main Street Store",
"externalId": "store-001",
"taxId": "12345678-9",
"isActive": true,
"isPlaceholder": false,
"metadata": {},
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
],
"meta": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1
}
}