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âmetroTipoPadrãoDescrição
pagenumber1Página atual
limitnumber20Itens por página (máx: 100)
statusstring-Filtrar por status: ativo, ganho, perdido, arquivado
phasestring-Filtrar por fase do pipeline
client_idstring-Filtrar por cliente
responsible_idstring-Filtrar por responsável
sourcestring-Filtrar por origem
store_idstring-Filtrar por loja
min_valuenumber-Valor mínimo
max_valuenumber-Valor máximo
fromstring-Data de criação inicial (YYYY-MM-DD)
tostring-Data de criação final (YYYY-MM-DD)
searchstring-Buscar por título ou descrição
sortstring-created_atOrdenaçã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

CampoTipoObrigatórioDescrição
titlestringSimTítulo do negócio
descriptionstringNãoDescrição detalhada
valuenumberNãoValor estimado
phasestringNãoFase inicial (padrão: "lead")
prioritystringNãoPrioridade: alta, media, baixa (padrão: "media")
probabilitynumberNãoProbabilidade de ganho (0–100)
expected_close_datestringNãoData prevista de fechamento (YYYY-MM-DD)
client_idstringNãoID do cliente
responsible_idstringNãoID do responsável
sourcestringNãoOrigem do negócio
store_idstringNãoID da loja
case_idstringNãoID do caso/veículo vinculado
tagsarrayNãoTags/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

CampoTipoDescrição
titlestringTítulo
descriptionstringDescrição
valuenumberValor estimado
phasestringFase no pipeline
prioritystringPrioridade: alta, media, baixa
statusstringStatus: ativo, ganho, perdido, arquivado
probabilitynumberProbabilidade (0–100)
expected_close_datestringData prevista de fechamento
responsible_idstringID do responsável
sourcestringOrigem
client_idstringID do cliente
case_idstringID do veículo/caso
loss_reasonstringMotivo da perda (quando status: "perdido")
tagsarrayTags/etiquetas
is_starredbooleanMarcar como favorito
store_idstringID 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:

FaseDescriçãoProbabilidade Sugerida
leadLead recém-chegado10%
qualificadoLead qualificado25%
propostaProposta enviada50%
negociacaoEm negociação75%
fechamentoFechamento iminente90%

Status dos Negócios

StatusDescrição
ativoNegócio em andamento
ganhoVenda concretizada
perdidoNegócio perdido para a concorrência
arquivadoArquivado (DELETE)

Origens Comuns

OrigemDescrição
showroomVisita ao showroom/loja
portalPortal de anúncios (OLX, Webmotors, etc.)
indicacaoIndicação de cliente
siteSite da loja
instagramInstagram
whatsappWhatsApp direto
parceiroParceiro comercial

Erros Comuns

CódigoErroSolução
400Campo 'title' é obrigatórioInclua o campo title
400Prioridade inválidaUse: alta, media ou baixa
400Probabilidade deve ser entre 0 e 100Use valor entre 0 e 100
400Nenhum campo para atualizarEnvie ao menos um campo no body do PUT
404Negócio não encontradoVerifique o ID

On this page