/
Consulta de Status do Pedido (/getStatus)
Consulta de Status do Pedido (/getStatus)
- Bsoft - Suporte (Unlicensed)
- Documentação
Owned by Bsoft - Suporte (Unlicensed)
fev. 07, 2023
Loading data...
Índice 
Autenticação
Parâmetros da URL
| Parâmetro | Descrição |
|---|---|
| cnpj | CNPJ do Cliente |
| cpf | CPF do Cliente |
| documentNumber | Número do Documento |
| key | Chave do Documento |
Retorno
Exemplo: retorno endpoint getStatus
{
"user_message": "1 Documento(s) encontrado(s).",
"internal_message": "",
"response_data": [
{
"Documento": {
"NumeroNF": "123456",
"NumeroPedido": null,
"Nome": "DESTINO",
"Logradouro": "Rua Exemplo",
"Bairro": "Centro",
"Cidade": "Rio de Janeiro",
"Estado": "RJ",
"Latitude": null,
"Longitude": null,
"NomeTransportadora": "TRANSPORTADORA EXEMPLO",
"CnpjTransportadora": "00007075000102",
"PrazoSLA": null,
"SLADiasUteis": null,
"DataHora": "01/02/2023 10:47:50",
"Foto": null,
"PrevisaoEntrega": null,
"CodigoStatus": "0",
"Status": "Em Rota",
"DescricaoStatus": "Documento está em uma rota que foi iniciada",
"CodOcorrencia": null,
"DescricaoOcorrencia": null,
"Rota": "2, 000 e 007",
"DataRota": "01/02/2023",
"Motorista": "MOTORISTA/Proprietario ",
"Placa": "ABC1D23",
"Itens": [
{
"Codigo": "123456",
"Descricao": "NAT1",
"Quantidade": "44"
}
],
"Pedidos": [],
"LinkTracking": "https://tracking.comprovei.com/#/track/S0vbGEFbYwcAZh6wfb7tPhBzQII4zu1U"
}
}
],
"code": 200,
"more_info": "http://dev.comprovei.com"
}
Mensagens de Retorno - Sucesso
Código | Parâmetro | Descrição |
|---|---|---|
| 200 | user_message | Documento não encontrado. |
200 | user_message | 1 Documento(s) encontrado(s). |
Mensagens de Retorno - Erro
| Código (parâmetro Code) | Parâmetro | Descrição |
|---|---|---|
| 400 | user_message | Dados não foram preenchidos para busca. |
401 | internal_message | Usuário e/ou senha do desenvolvedor inválidos |
402 | internal_message | Sem dados de autenticação do desenvolvedor |
Status dos Documentos
Código | Status (parâmetro Status) | Descrição (parâmetro DescricaoStatus) |
|---|---|---|
| 0 | Em Rota | Documento está em uma rota que foi iniciada |
| 1 | A caminho | Documento é o próximo a ser entregue |
| 2 | Chegou | Motorista chegou no cliente |
| 3 | Entregue | Documento entregue |
| 4 | Entregue SL | Documento entregue sem a conferencia dos itens |
| 5 | Em Pausa | Motorista fez uma pausa na viagem |
| 6 | Não entregue | Documento não foi entregue |
| 7 | Abortada | Motorista abortou a entrega |
| 8 | Coletado | Documento foi coletado |
| 9 | Não coletado | Documento não foi coletado |
| 10 | Conferindo | Itens estão sendo conferidos |
| 11 | Conferido | Itens foram conferidos |
| 12 | Sem Rota | Documento não está presente em nenhuma rota |
| 13 | Devolvido | Documento foi devolvido |
| 14 | Cancelado | Entrega foi cancelada |
| 15 | Agendado | Documento sofreu agendamento |
| 16 | Com Ajudante | Ajudante do motorista está com o documento para entrega |
| 17 | Transferido | Documento foi entregue na base após o transbordo |
| 18 | Em Transferência | Documento está a caminho da base |
| 20 | Programado | Documento tem data programada para envio |
Segunda a Sexta: das 8:00 às 18:00 (exceto feriados) Sábado: das 8:00 às 12:00.