---
title: "Consulta Resultado Da Pesquisa Em Lote De Veículos"
method: GET
path: "/vehicle/debts/batch/{batch_id}/results/"
tags: ["Consulta de Débitos Veiculares"]
---

# Consulta Resultado Da Pesquisa Em Lote De Veículos

`GET /vehicle/debts/batch/{batch_id}/results/`

A API de consulta de débitos veiculares permite que o cliente consulte os débitos de um veículo a partir de um fluxo assíncrono.

> Antes de realizar uma consulta, você deverá cadastrar uma URL para receber as atualizações de status da pesquisa via webhook através [deste endpoint](#tag/Webhook).
>
>
> [Neste link](https://docs-b2b.usezapay.com.br/docs/webhooks) você poderá encontrar um guia com maiores detalhes de como cadastrar um endpoint webhook para receber os resultados da sua pesquisa.

Ao realizar a requisição com sucesso, você receberá um código através do campo `batch_id`. Segundos depois, você receberá um webhook com a url para consultar o resultado final.
Além disso, com o batch_id também é possível consultar o status da requisição de pesquisa. Através do endpoint [status](#tag/#tag/Consulta-de-Debitos-Veiculares/operation/Verificação_de_status_da_pesquisa_em_lote_de_veículos_vehicle_debts_batch__batch_id__status__get)

#### Eventos de Pesquisa de Débitos Veiculares que poderão aparecer nos eventos vinculados a aquele veículo são.

| Evento | Descrição |
| --- | --- |
| vehicle_debts_found | Foram encontrados débitos para o veículo pesquisado. |
| vehicle_debt_not_found | Não foram encontrados débitos para o veículo pesquisado. |
| vehicle_not_found | O veículo informado não foi encotrado. |
| vehicle_debt_search_error | Houve algum erro ao tentar realizar a pesquisa de débitos do veículo (Detalhes serão informados no corpo do evento) |
| vehicle_enriched_partially | A pesquisa não foi concluída porque não foi possível encontrar dados adicionais do veículo. |

Em [nosso guia de uso](https://docs-b2b.usezapay.com.br/docs/consulta-de-debitos#consultando-os-d%C3%A9bitos-de-um-ve%C3%ADculo), você poderá encontrar exemplos de payloads que seu endpoint receberá de acordo com cada um dos eventos listados acima.

Para testar o comportamento dessa API e diferentes tipos de retorno em ambiente sandbox, separamos um conjunto de placas de testes para você [neste link](https://docs-b2b.usezapay.com.br/docs/consulta-de-debitos#massa-de-testes).

## Path parameters

- `batch_id` string, required

## Response `200`

Sucesso

- SearchRequestBatchResultDTOInput
  - `batch` VehicleRequestBatchModelBaseInfoDTO, required
    - `id` string, required — Id da requisição de pesquisa em lote
    - `fleet_id` string, nullable, required — Id da frota da requisição de pesquisa em lote
  - `webhook` WebhookShortModel, required
    - `id` string, required — Id único do webhook
    - `resource` 'vehicle_debt' | 'vehicle_debt_batch' | 'checkout' | 'autoradar' | 'payment_recurrence' | 'documents' | 'monitoring' | 'document_order'
    - `version` string — Versão do webhook
  - `status` 'created' | 'processing' | 'done' | 'failed'
  - `batch_debts` object — Resultado de requisições do lote

## Other responses

- `401` — Unauthorized
- `422` — Validation Error
- `503` — Serviço temporariamente indisponível

---

[API](https://skmtc.net/usezapay/apis/zapi.md) · [All operations](https://skmtc.net/usezapay/apis/zapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usezapay/zapi/revisions/50c96157fff4/schema)