WS603 - Export Document History

This integration aims to export the history of Comprovei Documents

Authentication

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

Features

URL

https://api.comprovei.com.br/api/1.1/util/export/documentHistory
Method:

POST
URL parameter:

No parameters

Example:

{
    "headers": {
        "username": "usuario",
        "password": "senha"
    },
    "body": {
        "formato_exportacao" : "xml",
        "filtros": {
            "data_inicial": "2020-01-01",
            "data_final": "2020-01-01",
            "regioes":["String"],
            "transportadoras":["String","String2"],
            "embarcadores":["String","String2"]
        },
        "campos": [
            "Num. documento",
            "CNPJ embarcador",
            "Nome embarcador",
            "Região",
            "CNPJ cliente",
            "Nome cliente",
            "Status da nota",
            "Valor",
            "Volume",
            "Qtd volumes",
            "Chave nota",
            "Numero da rota",
            "Motorista",
            "Cód. motorista",
            "Placa",
            "CNPJ transportadora",
            "Transportadora",
            "Data transferencia",
            "Data entrega",
            "Base origem",
            "Base destino",
            "Tipo de frete",
            "Data de emissão",
            "Nome do responsável",
            "Data de agendamento",
            "Inicio do transbordo",
            "Status SLA transbordo",
            "Data prazo transbordo",
            "Transp. Transbordo",
            "Inicio da distribuição",
            "Status SLA distribuição",
            "Data prazo distribuição",
            "Transp. Distribuição",
            "Status SLA documento",
            "Data prazo documento",
            "Quantidade de paradas",
            "Peso do Documento",
            "Numero do pedido",
            "Rua",
            "Bairro",
            "CEP",
            "Cidade",
            "Estado",
            "Nome do gerente",
            "Codigo do gerente",
            "Email do gerente",
            "Telefone do gerente",
            "Nome do supervisor",
            "Codigo do supervisor",
            "Email do supervisor",
            "Telefone do supervisor",
            "Nome do gerente senior",
            "Codigo do gerente senior",
            "Email do gerente senior",
            "Telefone do gerente senior",
            "Nome do vendedor",
            "Codigo do vendedor",
            "Email do vendedor",
            "Telefone do vendedor",
            "Ultima ocorrencia",
            "Data de atualização",
            "Data da rota de distribuição",
            "Data da rota de transbordo",
            "Danfe",
            "Data de criação da rota de transbordo",
            "Data de criação da rota de distribuição",
            "Data de finalização",
            "Tipo de Rota",
            "AWB"
        ],
        "campos_inclusos": [
            "Num. documento",
            "CNPJ embarcador",
            "Nome embarcador",
            "Região"
        ]
    }
}

Important

"fields" is used to define the names of the fields that should be used in the export. No fields should be added or removed, just changed.
The "fields" field must not have its order changed, however the name of the fields can be changed for export.
If the "fields" and "included_fields" fields are not passed, the system default determined by the support team will be used.
Some fields will not be sent by default because they require a lot of processing, even when passed in the parameters, due to the high level of processing required. If the field is really necessary, contact support to have it released to your user in question.
In "included_fields" it is possible to select which fields and in what order they will be exported, the field names must be the same as the "fields" field. If you want to export all fields, do not add "included_fields".
In "formato_exportação" it is possible to select which export model, the following are accepted: xml, xls, json and csv;

Response Example

Success:

{
    "statusCode": 200,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "user_message": "https://comprovei.s3.amazonaws.com/producao/report_requests/export/21/routeExport-20200525192526.csv.zip?  X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJELIIV2RATTMVK7A%2F20200525%2Fus-east-1%2Fs3%2Faws4_request&    X-Amz-Date=20200525T192538Z&X-Amz-Expires=259200&   X-Amz-Signature=19d54276cff1a3f1e074bac3e5f7737d670030f5bfb8267fbfebeb335a2dfca4&X-Amz-SignedHeaders=host",
        "code": 0,
        "internal_message": "Exportação gerada com sucesso!",
        "response_data": ""
    }
}

Error:

{
    "statusCode": 400,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "message": "Não foram encontrados resultados para os filtros selecionados!"
    }
}

Error:

{
    "statusCode": 400,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "message": "Algum campo de data está no formato errado. Tente (aaaa-mm-dd)"
    }
}

Error:

{
    "statusCode": 400,
    "headers": {
        "Content-Type": "application/json",
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Credentials": true
    },
    "body": {
        "message": "O intervalo de datas não pode ter mais de 31 dias"
    }
}