WS613 - Exportar relatório de Documentos

Esta integração tem por objetivo exportar o relatório de Documentos do Comprovei

Autenticação

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

Características

• URL

  <https://console-api.comprovei.com/exports/documentSAC>

• Método:

  POST

• Parâmetro URL:

  Sem parâmetros

• Exemplo:

  {
      "headers": {
          "username": "usuario",
          "password": "senha"
      },
      "body": {
          "formato_exportacao" : "xml",
          "filtros": {
              "data_inicial": "2020-01-01",
              "data_final": "2020-01-01",
              "data_emissao_inicial": "2020-01-01",
              "data_emissao_final": "2020-01-01",
              "data_rota_inicial": "2020-01-01",
              "data_rota_final": "2020-01-01",
              "excluir_transbordos": false,
              "regioes": ["int", "int2"],
              "embarcadores": ["String","String2"],
              "transportadoras": ["String","String2"],
          },
          "campos":[
              "Documento",
              "Emissão",
              "CNPJ Embarcador",
              "Embarcador",
              "Região",
              "Modelo",
              "CNPJ Cliente",
              "Código Cliente",
              "Código Int Cliente",
              "Tipo",
              "Cliente",
              "Cidade Destino",
              "UF Destino",
              "Data Finalização",
              "Ultima Ocorrência",
              "Status",
              "Data Pagamento",
              "Data Agendamento",
              "Qtd Reentregas",
              "Qtd Paradas",
              "Chave",
              "Valor",
              "Volume",
              "Qtd volumes",
              "Conferidos",
              "Rota/Roteiro",
              "Motorista",
              "Cód. Motorista",
              "Placa",
              "Data da rota",
              "Transportadora",
              "CNPJ Transp.",
              "Data Últ. Ocorr.",
              "Gerente Cód.",
              "Gerente Nome",
              "Gerente Email",
              "Gerente Tel.",
              "Supervisor Cód.",
              "Supervisor Nome",
              "Supervisor Email",
              "Supervisor Tel.",
              "Gerente Sênior Cód.",
              "Gerente Sênior Nome",
              "Gerente Sênior Email",
              "Gerente Sênior Tel.",
              "Vendedor Cód.",
              "Vendedor Nome",
              "Vendedor Email",
              "Vendedor Tel.",
              "Pedido",
              "Base Origem",
              "Base Destino",
              "Prazo SLA",
              "Status SLA",
              "Tipo de Frete",
              "Modal",
              "Data Atualização",
              "AWB",
              "Remessa",
              "Possui Foto",
              "Performance SLA",
              "Justificativa",
              "Acatado",
              "Comentário da Justificativa",
              "Chegada Cliente",
              "Ajuste Manual",
              "Horario Ajuste Manual",
              "Usuário Ajuste Manual",
              "Código IBGE Cidade",
              "BU",
              "CFOP",
              "Campo Livre 1",
              "Campo Livre 2",
              "Campo Livre 3",
              "Campo Livre 4",
              "Campo Livre 5",
              "Email SLA Atrasado"
          ],
          "campos_inclusos": [
              "Documento",
              "Emissão",
              "CNPJ Embarcador",
              "Embarcador",
              "Região"
          ]
      }
  }
  

  Importante

  • "campos" é usado para definir os nomes dos campos que devem ser utilizados na exportação. Nenhum campo deve ser adicionado ou retirado, apenas alterados.
  • O campo "campos" não deve ter sua ordem alterada, porém o nome dos campos pode ser alterado para a exportação.
  • Em "campos_inclusos" é possível selecionar quais campos e em que ordem eles serão exportados, os nomes dos campos devem ser iguais ao do campo "campos". Caso queira exportar todos os campos, não acrescentar "campos_inclusos".
  • Em "formato_exportação" é possível selecionar qual modelo da exportação, são aceitos: xml, xls, json e csv;

  Exemplo de Response

  • Sucesso:

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

  • Erro:

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

  • Erro:

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

    • Erro:

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