API
Negócios (Deals)
Gerenciar pipeline de vendas de veículos via API.
Negócios (Deals)
Gerencie o pipeline de vendas da sua loja ou shopping automotivo. Negócios representam oportunidades de venda — potenciais compradores ou negociações em andamento.
GET /api/v1/deals
Lista todos os negócios do time.
Query Parameters
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | number | 1 | Página atual |
limit | number | 20 | Itens por página (máx: 100) |
status | string | - | Filtrar por status: ativo, ganho, perdido, arquivado |
phase | string | - | Filtrar por fase do pipeline |
client_id | string | - | Filtrar por cliente |
responsible_id | string | - | Filtrar por responsável |
source | string | - | Filtrar por origem |
store_id | string | - | Filtrar por loja |
min_value | number | - | Valor mínimo |
max_value | number | - | Valor máximo |
from | string | - | Data de criação inicial (YYYY-MM-DD) |
to | string | - | Data de criação final (YYYY-MM-DD) |
search | string | - | Buscar por título ou descrição |
sort | string | -created_at | Ordenação |
Request
curl -X GET "https://dashboard.ecosysauto.ai/api/v1/deals?status=ativo&phase=proposta" \
-H "Authorization: Bearer ea_live_sua_chave_aqui"Response
{
"success": true,
"data": [
{
"id": "uuid-do-negocio",
"title": "Venda Honda Civic 2024 — Cliente João",
"description": "Cliente interessado no Honda Civic EXL 2024 preto",
"value": 142900.00,
"currency": "BRL",
"phase": "proposta",
"priority": "media",
"probability": 60,
"status": "ativo",
"expected_close_date": "2026-03-15",
"source": "showroom",
"loss_reason": null,
"tags": ["civic"],
"is_starred": false,
"store_id": "uuid-da-loja",
"client_id": "uuid-do-cliente",
"client": {
"id": "uuid-do-cliente",
"name": "João da Silva"
},
"responsible_id": "uuid-do-usuario",
"case_id": null,
"ai_summary": null,
"ai_win_probability": null,
"created_at": "2026-01-20T10:00:00Z",
"updated_at": "2026-02-04T14:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 25,
"pages": 2
}
}POST /api/v1/deals
Cria um novo negócio.
Request Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | Título do negócio |
description | string | Não | Descrição detalhada |
value | number | Não | Valor estimado |
phase | string | Não | Fase inicial (padrão: "lead") |
priority | string | Não | Prioridade: alta, media, baixa (padrão: "media") |
probability | number | Não | Probabilidade de ganho (0–100) |
expected_close_date | string | Não | Data prevista de fechamento (YYYY-MM-DD) |
client_id | string | Não | ID do cliente |
responsible_id | string | Não | ID do responsável |
source | string | Não | Origem do negócio |
store_id | string | Não | ID da loja |
case_id | string | Não | ID do caso/veículo vinculado |
tags | array | Não | Tags/etiquetas |
Request
curl -X POST https://dashboard.ecosysauto.ai/api/v1/deals \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"title": "Venda Toyota Corolla 2025 — Empresa ABC",
"value": 165000.00,
"phase": "lead",
"priority": "alta",
"probability": 30,
"expected_close_date": "2026-04-01",
"client_id": "uuid-do-cliente",
"source": "portal",
"description": "Cliente interessado no Corolla 2025 após ver anúncio no portal",
"tags": ["corolla", "alta-margem"]
}'Response (201 Created)
{
"success": true,
"data": {
"id": "uuid-do-negocio",
"title": "Venda Toyota Corolla 2025 — Empresa ABC",
"description": "Cliente interessado no Corolla 2025 após ver anúncio no portal",
"value": 165000.00,
"currency": "BRL",
"phase": "lead",
"priority": "alta",
"probability": 30,
"status": "ativo",
"expected_close_date": "2026-04-01",
"source": "portal",
"loss_reason": null,
"tags": ["corolla", "alta-margem"],
"is_starred": false,
"store_id": null,
"client_id": "uuid-do-cliente",
"client": {
"id": "uuid-do-cliente",
"name": "AutoPeças ABC Ltda"
},
"responsible_id": null,
"case_id": null,
"ai_summary": null,
"ai_win_probability": null,
"created_at": "2026-02-04T10:30:00Z",
"updated_at": "2026-02-04T10:30:00Z"
}
}GET /api/v1/deals/:id
Busca um negócio específico.
Request
curl -X GET https://dashboard.ecosysauto.ai/api/v1/deals/uuid-do-negocio \
-H "Authorization: Bearer ea_live_sua_chave_aqui"PUT /api/v1/deals/:id
Atualiza um negócio. Use este endpoint para mover fases, alterar valor, e também para marcar como ganho ou perdido.
Campos Atualizáveis
| Campo | Tipo | Descrição |
|---|---|---|
title | string | Título |
description | string | Descrição |
value | number | Valor estimado |
phase | string | Fase no pipeline |
priority | string | Prioridade: alta, media, baixa |
status | string | Status: ativo, ganho, perdido, arquivado |
probability | number | Probabilidade (0–100) |
expected_close_date | string | Data prevista de fechamento |
responsible_id | string | ID do responsável |
source | string | Origem |
client_id | string | ID do cliente |
case_id | string | ID do veículo/caso |
loss_reason | string | Motivo da perda (quando status: "perdido") |
tags | array | Tags/etiquetas |
is_starred | boolean | Marcar como favorito |
store_id | string | ID da loja |
Atualizar fase do pipeline
curl -X PUT https://dashboard.ecosysauto.ai/api/v1/deals/uuid-do-negocio \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"phase": "negociacao",
"probability": 75
}'Marcar negócio como ganho
curl -X PUT https://dashboard.ecosysauto.ai/api/v1/deals/uuid-do-negocio \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"status": "ganho",
"value": 139900.00,
"phase": "fechamento"
}'Marcar negócio como perdido
curl -X PUT https://dashboard.ecosysauto.ai/api/v1/deals/uuid-do-negocio \
-H "Authorization: Bearer ea_live_sua_chave_aqui" \
-H "Content-Type: application/json" \
-d '{
"status": "perdido",
"loss_reason": "Preço acima do orçamento do cliente"
}'Response
{
"success": true,
"data": {
"id": "uuid-do-negocio",
"title": "Venda Honda Civic 2024 — Cliente João",
"value": 139900.00,
"phase": "negociacao",
"priority": "media",
"probability": 75,
"status": "ativo",
"updated_at": "2026-02-04T15:00:00Z"
}
}DELETE /api/v1/deals/:id
Arquiva um negócio (soft delete — define status como "arquivado").
Request
curl -X DELETE https://dashboard.ecosysauto.ai/api/v1/deals/uuid-do-negocio \
-H "Authorization: Bearer ea_live_sua_chave_aqui"Response
{
"success": true,
"data": {
"id": "uuid-do-negocio",
"status": "arquivado",
"archived_at": "2026-02-04T17:00:00Z"
}
}Fases do Pipeline
As fases são configuráveis por time. Fases padrão:
| Fase | Descrição | Probabilidade Sugerida |
|---|---|---|
lead | Lead recém-chegado | 10% |
qualificado | Lead qualificado | 25% |
proposta | Proposta enviada | 50% |
negociacao | Em negociação | 75% |
fechamento | Fechamento iminente | 90% |
Status dos Negócios
| Status | Descrição |
|---|---|
ativo | Negócio em andamento |
ganho | Venda concretizada |
perdido | Negócio perdido para a concorrência |
arquivado | Arquivado (DELETE) |
Origens Comuns
| Origem | Descrição |
|---|---|
showroom | Visita ao showroom/loja |
portal | Portal de anúncios (OLX, Webmotors, etc.) |
indicacao | Indicação de cliente |
site | Site da loja |
instagram | |
whatsapp | WhatsApp direto |
parceiro | Parceiro comercial |
Erros Comuns
| Código | Erro | Solução |
|---|---|---|
400 | Campo 'title' é obrigatório | Inclua o campo title |
400 | Prioridade inválida | Use: alta, media ou baixa |
400 | Probabilidade deve ser entre 0 e 100 | Use valor entre 0 e 100 |
400 | Nenhum campo para atualizar | Envie ao menos um campo no body do PUT |
404 | Negócio não encontrado | Verifique o ID |