WS204 - Check Order Status

Click here to see version history

Update date	Service publication date	Changes
03/05/2021	03/05/2021	Addition of last recorded position fields.

This integration aims to obtain the status of a document in the system.

Authentication

Calls will have transport-level authentication (Basic Authentication);
Request user / password from the account administrator.

Version

You are accessing version 2 of our integration system. If you wish to consult the previous version, click here.

Features

URL

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

GET
URL parameter:
- cnpj: Customer's CNPJ
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?cnpj=00007075000102
- cpf: Customer CPF
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?cpf=55411434467
- cnpj: Customer CNPJ & documentNumber: Document number
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?cnpj=00007075000102&documentNumber=271410
- cpf: Customer CPF & documentNumber: Document number
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?cpf=55411434467&documentNumber=271410
- orderNumber: Order number
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?orderNumber=1905880818
- key: Document key
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?key=32190381887838000736550020002714101002714100
- documentNumber: Document number & cnpjShipper: Issuer's CNPJ
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?documentNumber=271410&cnpjShipper=81887838000736
- documentNumber: Document number & series: Document series & cnpjShipper: Issuer's CNPJ
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?documentNumber=271410&series=2&cnpjShipper=81887838000736
- clientOrder: Customer Order Number
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?clientOrder=115652
- innerOrderNumber: Internal order number
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?innerOrderNumber=556242
- clientOrder: Customer Order Number & dateOrder: Order date
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?clientOrder=115652&dateOrder=2022-05-25
- innerOrderNumber: Internal order number & dateOrder: Order date
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?innerOrderNumber=556242&dateOrder=2022-05-25
- shipping: Shipping number
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?shipping=19478
- route: Document route & routeDate: Date of the route in question
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?route=routeExample2&routeDate=2023-11-30
- route: Document route & routeDate: Route date & routeDriver: Driver of the route in question
  - Example: https://api.comprovei.com.br/api/1.1/documents/getStatus?route=routeExample2&routeDate=2023-11-30&routeDriver=motorista
Data Parameter:

No parameters

Success:

Code: 200
Content:

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

Code: 200
Content:

{
    "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/"
}

Error:

Code: 400
Content:

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

Code: 401
Content:

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

Code: 402
Content:

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

Document status:

Code	Status	Description
0	On Route	Document is on a route that has been started
1	On the way	Document is next to be delivered
2	Arrived	Driver arrived at the customer
3	Delivered	Document delivered
4	Deliver SL	Document delivered without checking the items
5	On Pause	Driver took a break from the journey
6	Not delivered	Document was not delivered
7	Aborted	Driver aborted delivery
8	Collected	Document has been collected
9	Not collected	Document was not collected
10	Checking	Items are being checked
11	Checked	Items have been checked
12	No Route	Document is not present on any route
13	Returned	Document was returned
14	Canceled	Delivery was canceled
15	Scheduled	Document has been scheduled
16	With Helper	Driver's assistant has the document for delivery
17	Transferred	Document was delivered to the base after transshipment
18	In Transfer	Document is on its way to the base
20	Scheduled	Document has a scheduled date for sending