WS204 - Consultar Status do Pedido

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
05/03/2021	05/03/2021	Acréscimo dos campos de última posição registrada.

Esta integração tem por objetivo permitir obter o status de um documento no sistema.

Autenticação

As chamadas terão autenticação a nível de transporte (Basic Authentication);
Solicite o user / password ao administrador da conta.

Versão

Você está acessando a versão 2 do nosso sistema de integração. Caso deseje consultar a versão anterior, clique aqui.

Características

URL

https://api.comprovei.com.br/api/1.1/documents/getStatus?cnpj&cpf&orderNumber&key&documentNumber&series&cnpjShipper&innerOrderNumber&clientOrder
Método:

GET
Parâmetro URL:
- cnpj: CNPJ do cliente
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?cnpj=00007075000102
- cpf: CPF do cliente
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?cpf=55411434467
- cnpj: CNPJ do cliente & documentNumber: Número do documento
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?cnpj=00007075000102&documentNumber=271410
- cpf: CPF do cliente & documentNumber: Número do documento
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?cpf=55411434467&documentNumber=271410
- orderNumber: Número do pedido
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?orderNumber=1905880818
- key: Chave do documento
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?key=32190381887838000736550020002714101002714100
- documentNumber: Número do documento & cnpjShipper: CNPJ do Emissor
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?documentNumber=271410&cnpjShipper=81887838000736
- documentNumber: Número do documento & series: Série do documento & cnpjShipper: CNPJ do Emissor
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?documentNumber=271410&series=2&cnpjShipper=81887838000736
- clientOrder: Número do Pedido do Cliente
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?clientOrder=115652
- innerOrderNumber: Número interno do pedido
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?innerOrderNumber=556242
- clientOrder: Número do Pedido do Cliente & dateOrder: Data do pedido
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?clientOrder=115652&dateOrder=2022-05-25
- innerOrderNumber: Número interno do pedido & dateOrder: Data do pedido
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?innerOrderNumber=556242&dateOrder=2022-05-25
- shipping: Número de remessa
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?shipping=19478
- route: Rota do documento & routeDate: Data da Rota em questão
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?route=routeExample2&routeDate=2023-11-30
- route: Rota do documento & routeDate: Data da Rota & routeDriver: Motorista da Rota em questão
  - Exemplo: https://api.comprovei.com.br/api/1.1/documents/getStatus?route=routeExample2&routeDate=2023-11-30&routeDriver=motorista
Parâmetro Data:

Sem parâmetros

Sucesso:

Código: 200
Conteúdo:

{
    "user_message": "Documento não encontrado.", 
    "internal_message": "", 
    "response_data": "", 
    "code": 200, 
    "more_info": "http://dev.comprovei.com.br"
}

Código: 200
Conteúdo:

{
    "user_message": "1 Documento(s) encontrado(s).",
    "internal_message": "",
    "response_data": [
        {
            "Documento": {
                "NumeroNF": "int",
                "NumeroPedido": "int",
                "Nome": "string",
                "Logradouro": "string",
                "Bairro": "string",
                "Cidade": "string",
                "Estado": "UF",
                "Latitude": "float",
                "Longitude": "float",
                "NomeTransportadora": "string",
                "CnpjTransportadora": "string",
                "PrazoSLA": "string",
                "SLADiasUteis": "string",
                "DataHora": "string",
                "Foto": "string",
                "PrevisaoEntrega": "string",
                "CodigoStatus": "int",
                "Status": "string",
                "DescricaoStatus": "string",
                "CodOcorrencia": "int",
                "DescricaoOcorrencia": "string",
                "Rota": "string",
                "TipoDeRota":"string",
                "DataRota": "string",
                "Motorista": "string",
                "Placa": "string",
                "Itens": [
                    {
                        "Codigo": "int",
                        "Descricao": "string",
                        "Quantidade": "int"
                    },
                    {
                        "Codigo": "int",
                        "Descricao": "string",
                        "Quantidade": "int"
                    }
                ],
                "Pedidos": [],
                "LinkTracking": "string"
            }
        }
    ],
    "code": 200,
    "more_info": "http://dev.comprovei.com/"
}

Erro:

Código: 400
Conteúdo:

{
    "user_message": "Dados não foram preenchidos para busca.", 
    "internal_message": "", 
    "response_data": "", 
    "code": 400, 
    "more_info": "http://dev.comprovei.com.br"
}

Código: 401
Conteúdo:

{
    "user_message": "",
    "internal_message": "Usuário e/ou senha do desenvolvedor inválidos", 
    "response_data": "", 
    "code": 401, 
    "more_info": "http://dev.comprovei.com.br"
}

Código: 402
Conteúdo:

{
    "user_message": "", 
    "internal_message": "Sem dados de autenticação do desenvolvedor", 
    "response_data": "", 
    "code": 402, 
    "more_info": "http://dev.comprovei.com.br"
}

Status dos documentos:

Código	Status	Descrição
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