Consultas — Status e Histórico
Consulte o status atual ou o histórico completo de qualquer pedido utilizando o codigoQiTech.
Consultar Status Atual
ENDPOINT
/v1/vehicles/contracts/status/MÉTODO
GETScope: vehicles/read
Request
Request Params
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigoQiTech | String | Identificador único do pedido (até 255 caracteres) | SIM |
Response (200)
Response Body
| Campo | Tipo | Descrição |
|---|---|---|
| codigoQiTech | String | Identificador único do pedido |
| etapaAtual | String | Etapa do processo (Inclusão de Gravame / Registro do Contrato / Aditivo do Contrato / Imagem de Contrato) |
| status | String | Status atual do processo (ver Mapa de Status) |
| msgRetornoProvedor | String | Mensagem de retorno do provedor (populado em caso de negativa) |
| msgRetornoPlataforma | String | Mensagem de retorno da plataforma (populado em caso de negativa) |
| dataUltimaAtualizacao | String | Data da última atualização (YYYY-MM-DD) |
| chassi | String | Chassi do veículo |
| ufDeLicenciamento | String | UF licenciamento do veículo |
| numGravame | String | Número do gravame (até 8 chars; "0" se ainda não houver) |
Consultar Histórico
ENDPOINT
/v1/vehicles/contracts/history/MÉTODO
GETScope: vehicles/read
Request
Request Params
| Campo | Tipo | Descrição | Obrig. |
|---|---|---|---|
| codigoQiTech | String | Identificador único do pedido (até 255 caracteres) | SIM |
Response (200)
Response Body
| Campo | Tipo | Descrição |
|---|---|---|
| codigoQiTech | String | Identificador único do pedido |
| historicoGarantia | String | Descritivo das operações realizadas com data/hora de cada |
| msgRetornoProvedor | String | Mensagem de retorno do provedor |
| msgRetornoPlataforma | String | Mensagem de retorno da plataforma |
| chassi | String | Chassi do veículo |
| ufDeLicenciamento | String | UF licenciamento |
| numGravame | String | Número do gravame (até 8 caracteres) |
Informação
Nos retornos "Negado", "Dados Inválidos" ou "Inválida", pelo menos um dos campos msgRetornoPlataforma e msgRetornoProvedor estará populado com o motivo.