Pular para o conteúdo principal

Listar Anúncios Vendidos

Consulte os anúncios de veículos já vendidos para uma loja específica.

Endpoint

GET /inventory/sold/{dealer_id}

Método

GET

Parâmetros de URL

ParâmetroTipoDescrição
dealer_idintegerID da loja

Autenticação

Este endpoint requer autenticação via JWT. Inclua o token no header:

Authorization: Bearer {access_token}

Exemplo de Resposta

Status Code: 200 OK

{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 12345,
"status": 2,
"category": 1,
"make": "Toyota",
"model": "Corolla",
"version": "XEi 2.0",
"year": {
"make": 2023,
"model": 2024
},
"license_plate": "ABC1234",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-20T14:45:00Z",
"created_by": "João Silva",
"updated_by": "Maria Santos",
"first_photo": "https://media.integradordeanuncios.com.br/thumb/10/foto1.jpg"
},
{
"id": 12346,
"status": 2,
"category": 2,
"make": "Honda",
"model": "CB 600F",
"version": "",
"year": {
"make": 2022,
"model": 2023
},
"license_plate": "XYZ5678",
"created_at": "2024-01-10T08:20:00Z",
"updated_at": "2024-02-15T16:30:00Z",
"created_by": "Pedro Costa",
"updated_by": "Ana Lima",
"first_photo": "https://media.integradordeanuncios.com.br/thumb/10/foto2.jpg"
}
]
}

Estrutura de Dados

A resposta é um objeto paginado com os seguintes campos:

CampoTipoDescrição
countintegerTotal de anúncios vendidos encontrados
nextstringURL da próxima página (null se não houver)
previousstringURL da página anterior (null se não houver)
resultsarrayArray com os resultados da página atual

Estrutura de um Item de Anúncio Vendido

CampoTipoDescrição
idintegerIdentificador único do anúncio
statusintegerID do status do anúncio (geralmente 2 = Vendido)
categoryintegerID da categoria (1=Automóvel, 2=Motocicleta, 3=Caminhão, 4=Implemento)
makestringNome da marca do veículo
modelstringNome do modelo do veículo
versionstringNome da versão do veículo (pode ser vazio para motocicletas)
yearobjectObjeto com ano de fabricação e modelo (ver abaixo)
license_platestringPlaca do veículo
created_atstringData e hora de criação do anúncio
updated_atstringData e hora de última atualização (pode ser null)
created_bystringNome do usuário que criou o anúncio
updated_bystringNome do usuário que atualizou o anúncio (pode ser null)
first_photostringURL da primeira foto (thumbnail)

Estrutura do Objeto year

CampoTipoDescrição
makeintegerAno de fabricação
modelintegerAno do modelo

Filtros

Este endpoint suporta os seguintes filtros através de query parameters:

ParâmetroTipoDescrição
statusintegerFiltra por ID do status
categoryintegerFiltra por categoria (1=Automóvel, 2=Motocicleta, 3=Caminhão, 4=Implemento)
is_newintegerFiltra por veículos novos (1) ou usados (0)

Exemplos de Uso de Filtros

Filtrar por categoria:

GET /inventory/sold/{dealer_id}?category=1

Filtrar por status:

GET /inventory/sold/{dealer_id}?status=2

Filtrar apenas veículos novos:

GET /inventory/sold/{dealer_id}?is_new=1

Combinar múltiplos filtros:

GET /inventory/sold/{dealer_id}?category=1&status=2

Query Parameters de Paginação

ParâmetroTipoDescrição
pageintegerNúmero da página
pageSizeintegerQuantidade de itens por página (padrão: definido nas configurações, máximo: 100)

Observações

  • Apenas anúncios de veículos vendidos são retornados
  • Apenas veículos vendidos nos últimos 180 dias são incluídos nos resultados
  • O campo version pode ser uma string vazia para veículos que não possuem versão específica (como algumas motocicletas)
  • O campo created_by retorna o nome de tratamento do usuário que criou o anúncio
  • O campo updated_by pode ser null se o anúncio nunca foi atualizado após a criação
  • O campo first_photo retorna a URL da primeira foto do anúncio (thumbnail). Se não houver fotos, retorna uma string vazia
  • Os resultados são ordenados por padrão (geralmente por ID decrescente, mais recentes primeiro)
  • Este endpoint retorna apenas informações básicas dos anúncios vendidos. Para informações completas, use o endpoint /inventory/{dealer_id} filtrando por status vendido

Possíveis Retornos de Erro

400 Bad Request

Retornado quando o parâmetro dealer_id não é fornecido.

{
"detail": "Parâmetro ID da Loja não encontrado"
}

401 Unauthorized

Retornado quando o token de autenticação não foi fornecido ou é inválido.

{
"detail": "As credenciais de autenticação não foram fornecidas."
}

ou

{
"detail": "Token inválido ou expirado."
}

403 Forbidden

Retornado quando o usuário autenticado não tem permissão para acessar este recurso.

{
"detail": "Você não tem permissão para executar essa ação."
}

404 Not Found

Retornado quando a loja especificada não é encontrada.

{
"detail": "Não encontrado."
}