API

Veículos (Vehicles)

Criar, listar, atualizar e gerenciar veículos do inventário via API.

Veículos (Vehicles)

Gerencie o inventário de veículos da sua loja ou shopping automotivo. Veículos são o core do Ecosys Auto — representam carros, motos, caminhões e qualquer veículo disponível para venda.

GET /api/v1/vehicles

Lista todos os veículos do time.

Query Parameters

ParâmetroTipoPadrãoDescrição
pagenumber1Página atual
limitnumber20Itens por página (máx: 100)
statusstring-Filtrar por status
phasestring-Filtrar por fase do kanban
prioritystring-Filtrar por prioridade: alta, media, baixa
brandstring-Filtrar por marca (busca parcial)
client_idstring-Filtrar por cliente (proprietário/consignante)
responsible_idstring-Filtrar por responsável
store_idstring-Filtrar por loja
fromstring-Data de criação inicial (YYYY-MM-DD)
tostring-Data de criação final (YYYY-MM-DD)
sortstring-created_atOrdenação (prefixo - para descendente)
searchstring-Buscar por título, marca, modelo ou placa

Request

curl -X GET "https://dashboard.ecosysauto.ai/api/v1/vehicles?status=ativo&brand=Honda" \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid-do-veiculo",
      "title": "Honda Civic EXL 2.0 2024",
      "brand": "Honda",
      "model": "Civic",
      "version": "EXL 2.0 Flex",
      "year_model": 2024,
      "year_manufacture": 2023,
      "phase": "em-vitrine",
      "priority": "alta",
      "status": "ativo",
      "price": 142900.00,
      "purchase_price": 125000.00,
      "fipe_price": 148000.00,
      "fipe_code": "001004-9",
      "mileage": 18500,
      "color": "Preto",
      "fuel": "flex",
      "transmission": "automatico",
      "plate": "ABC1D23",
      "chassis_number": null,
      "renavam": null,
      "doors": 4,
      "engine": "2.0",
      "body_type": "sedan",
      "features": null,
      "description": "Veículo em excelente estado.",
      "tags": ["destaque", "seminovo-premium"],
      "store_id": "uuid-da-loja",
      "client_id": "uuid-do-cliente",
      "client": {
        "id": "uuid-do-cliente",
        "name": "João da Silva"
      },
      "entry_date": "2026-01-15",
      "days_in_inventory": 20,
      "is_published": false,
      "thumbnail_url": null,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-02-04T14:20:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

POST /api/v1/vehicles

Cadastra um novo veículo.

store_id obrigatório

Você precisa informar o store_id da loja onde o veículo será cadastrado. O ID da loja pode ser obtido nas Configurações → Lojas do painel.

Request Body

CampoTipoObrigatórioDescrição
titlestringSimTítulo do anúncio do veículo
store_idstringSimID da loja onde o veículo será cadastrado
brandstringNãoMarca (Honda, Toyota, VW, etc.)
modelstringNãoModelo (Civic, Corolla, Gol, etc.)
versionstringNãoVersão/acabamento
year_modelnumberNãoAno modelo
year_manufacturenumberNãoAno fabricação
pricenumberNãoPreço de venda
purchase_pricenumberNãoPreço de compra
fipe_pricenumberNãoValor FIPE de referência
fipe_codestringNãoCódigo FIPE
mileagenumberNãoQuilometragem
colorstringNãoCor do veículo
fuelstringNãoCombustível: flex, gasolina, etanol, diesel, eletrico, hibrido
transmissionstringNãoCâmbio: automatico, manual, cvt, automatizado
platestringNãoPlaca do veículo
chassis_numberstringNãoNúmero do chassi
renavamstringNãoRENAVAM
doorsnumberNãoNúmero de portas
enginestringNãoMotor (ex: "2.0", "1.6 Turbo")
body_typestringNãoCarroceria: sedan, hatch, suv, pickup, van, coupe, wagon
phasestringNãoFase inicial no kanban (padrão: "entrada")
prioritystringNãoPrioridade: alta, media, baixa (padrão: media)
client_idstringNãoID do cliente (proprietário/consignante)
responsible_idstringNãoID do usuário responsável
descriptionstringNãoDescrição detalhada do veículo
tagsarrayNãoArray de tags/etiquetas
entry_datestringNãoData de entrada no estoque (YYYY-MM-DD, padrão: hoje)

Request

curl -X POST https://dashboard.ecosysauto.ai/api/v1/vehicles \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Honda Civic EXL 2.0 2024",
    "store_id": "uuid-da-loja",
    "brand": "Honda",
    "model": "Civic",
    "version": "EXL 2.0 Flex",
    "year_model": 2024,
    "year_manufacture": 2023,
    "price": 142900.00,
    "purchase_price": 125000.00,
    "mileage": 18500,
    "color": "Preto",
    "fuel": "flex",
    "transmission": "automatico",
    "plate": "ABC1D23",
    "doors": 4,
    "phase": "entrada",
    "priority": "alta",
    "client_id": "uuid-do-cliente",
    "description": "Veículo em excelente estado, único dono, todas as revisões na concessionária.",
    "tags": ["destaque", "seminovo-premium"]
  }'

Response (201 Created)

{
  "success": true,
  "data": {
    "id": "uuid-do-veiculo",
    "title": "Honda Civic EXL 2.0 2024",
    "brand": "Honda",
    "model": "Civic",
    "version": "EXL 2.0 Flex",
    "year_model": 2024,
    "year_manufacture": 2023,
    "price": 142900.00,
    "purchase_price": 125000.00,
    "mileage": 18500,
    "color": "Preto",
    "fuel": "flex",
    "transmission": "automatico",
    "plate": "ABC1D23",
    "phase": "entrada",
    "priority": "alta",
    "status": "ativo",
    "description": "Veículo em excelente estado, único dono, todas as revisões na concessionária.",
    "tags": ["destaque", "seminovo-premium"],
    "store_id": "uuid-da-loja",
    "client_id": "uuid-do-cliente",
    "client": {
      "id": "uuid-do-cliente",
      "name": "João da Silva"
    },
    "entry_date": "2026-02-04",
    "days_in_inventory": 0,
    "is_published": false,
    "thumbnail_url": null,
    "created_at": "2026-02-04T10:30:00Z",
    "updated_at": "2026-02-04T10:30:00Z"
  }
}

GET /api/v1/vehicles/:id

Busca um veículo específico por ID.

Request

curl -X GET https://dashboard.ecosysauto.ai/api/v1/vehicles/uuid-do-veiculo \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": {
    "id": "uuid-do-veiculo",
    "title": "Honda Civic EXL 2.0 2024",
    "brand": "Honda",
    "model": "Civic",
    "version": "EXL 2.0 Flex",
    "year_model": 2024,
    "year_manufacture": 2023,
    "price": 142900.00,
    "purchase_price": 125000.00,
    "fipe_price": 148000.00,
    "fipe_code": "001004-9",
    "mileage": 18500,
    "color": "Preto",
    "fuel": "flex",
    "transmission": "automatico",
    "plate": "ABC1D23",
    "chassis_number": null,
    "renavam": null,
    "doors": 4,
    "engine": "2.0",
    "body_type": "sedan",
    "features": null,
    "description": "Veículo em excelente estado, único dono...",
    "tags": ["destaque", "seminovo-premium"],
    "phase": "em-vitrine",
    "priority": "alta",
    "status": "ativo",
    "store_id": "uuid-da-loja",
    "client_id": "uuid-do-cliente",
    "client": {
      "id": "uuid-do-cliente",
      "name": "João da Silva"
    },
    "entry_date": "2026-01-15",
    "days_in_inventory": 20,
    "is_published": false,
    "thumbnail_url": null,
    "photos": null,
    "listing_photos": null,
    "listing_description": null,
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-02-04T14:20:00Z"
  }
}

PUT /api/v1/vehicles/:id

Atualiza um veículo existente. Todos os campos são opcionais — envie apenas o que deseja alterar.

Request Body

CampoTipoDescrição
titlestringTítulo do anúncio
brandstringMarca
modelstringModelo
versionstringVersão/acabamento
year_modelnumberAno modelo
year_manufacturenumberAno fabricação
pricenumberPreço de venda
purchase_pricenumberPreço de compra
fipe_pricenumberValor FIPE
fipe_codestringCódigo FIPE
mileagenumberQuilometragem
colorstringCor
fuelstringCombustível
transmissionstringCâmbio
platestringPlaca
chassis_numberstringChassi
renavamstringRENAVAM
doorsnumberNúmero de portas
enginestringMotor
body_typestringCarroceria
phasestringFase no kanban
prioritystringPrioridade: alta, media, baixa
statusstringStatus do veículo
client_idstringID do cliente
responsible_idstringID do responsável
descriptionstringDescrição
tagsarrayTags/etiquetas
store_idstringID da loja

Request

curl -X PUT https://dashboard.ecosysauto.ai/api/v1/vehicles/uuid-do-veiculo \
  -H "Authorization: Bearer ea_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "phase": "em-vitrine",
    "priority": "media",
    "price": 139900.00,
    "tags": ["destaque", "seminovo-premium", "preco-reduzido"]
  }'

Response

{
  "success": true,
  "data": {
    "id": "uuid-do-veiculo",
    "title": "Honda Civic EXL 2.0 2024",
    "phase": "em-vitrine",
    "priority": "media",
    "price": 139900.00,
    "tags": ["destaque", "seminovo-premium", "preco-reduzido"],
    "updated_at": "2026-02-04T15:00:00Z"
  }
}

DELETE /api/v1/vehicles/:id

Arquiva um veículo do inventário (soft delete — define status como "arquivado").

Esta operação não exclui permanentemente o veículo. Para reativá-lo, use PUT /api/v1/vehicles/:id com {"status": "ativo"}.

Request

curl -X DELETE https://dashboard.ecosysauto.ai/api/v1/vehicles/uuid-do-veiculo \
  -H "Authorization: Bearer ea_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": {
    "id": "uuid-do-veiculo",
    "status": "arquivado",
    "removed_at": "2026-02-04T15:30:00Z"
  }
}

Campos Calculados na Resposta

CampoDescrição
days_in_inventoryDias desde entry_date até hoje
is_publishedSe o veículo está publicado no portal
thumbnail_urlURL da foto principal
listing_photosFotos para publicação no portal
listing_descriptionDescrição gerada por IA para o portal

Erros Comuns

CódigoErroSolução
400Campo 'title' é obrigatórioInclua o campo title no body
400Campo 'store_id' é obrigatórioInclua o store_id da loja
400Store não encontrada ou não pertence ao timeVerifique se o store_id pertence ao seu time
400Prioridade inválidaUse: alta, media ou baixa
400Nenhum campo para atualizarEnvie ao menos um campo no body do PUT
404Veículo não encontradoVerifique o ID do veículo
422Placa já cadastradaPlaca do veículo já existe no time

Referência da API

Documentação completa de todos os endpoints da API Ecosys Auto.

Clientes

Gerenciar clientes Pessoa Física (PF) e Jurídica (PJ) via API.

On this page

Veículos (Vehicles)GET /api/v1/vehiclesQuery ParametersRequestResponsePOST /api/v1/vehiclesRequest BodyRequestResponse (201 Created)GET /api/v1/vehicles/:idRequestResponsePUT /api/v1/vehicles/:idRequest BodyRequestResponseDELETE /api/v1/vehicles/:idRequestResponseCampos Calculados na RespostaErros Comuns