Skip to content

WS309 - Get occurrence types

Our Occurrence Consultation service

This integration aims to open the search request for types of occurrences registered in the account.

Authentication

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

Features

  • URL

    <https://entregas-api.comprovei.com/v1/occurrences>

  • Method:

GET

Warning

This integration returns a protocol for monitoring - WS301

Note

The occurrences will be in the response_data field

  • Sample answers

    • Success:

      • Code 202 Content:
          {
              "message" : "OK",
              "protocol" : "<protocol>"
          }
      
    • Error:

      • Code 401
        Content:
            "Unauthorized"
        
  • Example of the generated file

Click here
    {
    "Coleta": [
        {
            "Codigo": "101",
            "Descricao": "Coleta efetuada",
            "Ocorrencia": "Coleta efetuada",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Sim",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "102",
            "Descricao": "Coleta com Divergência",
            "Ocorrencia": "Coleta Divergente",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "10x",
            "Descricao": "Ocorrência de coleta com outros detalhes/restrições",
            "Ocorrencia": "Coleta - Outros",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        }
    ],
    "Entrega": [
        {
            "Codigo": "000",
            "Descricao": "Entrega realizada normalmente",
            "Ocorrencia": "Entrega normal",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Sim",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "001",
            "Descricao": "Entrega com restrições",
            "Ocorrencia": "Entrega com restrições",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "new_photo",
            "Descricao": "Reenvio de foto entrega normal",
            "Ocorrencia": "Entrega Normal (Nova foto)",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Sim",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "00x",
            "Descricao": "Ocorrência de entregas com outros detalhes/restrições",
            "Ocorrencia": "Entrega - Outros",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        }
    ],
    "Não coleta": [
        {
            "Codigo": "300",
            "Descricao": "Não disponível pelo cliente para a retirada",
            "Ocorrencia": "Não liberado pelo cliente",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Sim",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "301",
            "Descricao": "Coleta não efetuada por falta de tempo",
            "Ocorrencia": "Não efetuada",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "302",
            "Descricao": "não há itens pra coletar",
            "Ocorrencia": "não há itens pra coletar",
            "GeraDevolucao": "Sim",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "tempo_limite_c",
            "Descricao": "Motorista ficou esperando mais que o tempo limite de espera",
            "Ocorrencia": "Tempo de espera excedido",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "30x",
            "Descricao": "Ocorrência de não coleta com outros detalhes/restrições",
            "Ocorrencia": "Não coleta - Outros",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        }
    ],
    "Transferido": [
        {
            "Codigo": "transferred",
            "Descricao": "Transferência Realizada",
            "Ocorrencia": "Transferência Realizada",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "transferredx",
            "Descricao": "Ocorrência de transferência com outros detalhes/restrições",
            "Ocorrencia": "Transferência - Outros",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        }
    ],
    "Não entrega": [
        {
            "Codigo": "012",
            "Descricao": "ENTREGA PREJUDICADA POR HORARIO",
            "Ocorrencia": "Fora do horario",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "013",
            "Descricao": "ESTABELECIMENTO FECHADO",
            "Ocorrencia": "Estab fechado",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Sim",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "014",
            "Descricao": "FALTA DE XML",
            "Ocorrencia": "Falta de XML",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "017",
            "Descricao": "FERIADO LOCAL/NACIONAL",
            "Ocorrencia": "Feriado Local/Nacional",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "019",
            "Descricao": "PROBLEMA COM MERCADORIA",
            "Ocorrencia": "Probl com mercadoria",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "020",
            "Descricao": "PROBLEMA COM O PEDIDO",
            "Ocorrencia": "Problema com o pedido",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "022",
            "Descricao": "PROBLEMA NO RECEBIMENTO DO CLIENTE",
            "Ocorrencia": "Probl recebimento cliente",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "998",
            "Descricao": "Falha de procedimento. O motorista deveria registrar por que a  entrega não foi realizada",
            "Ocorrencia": "Motorista nao justificou",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "015",
            "Descricao": "ATRASO NA ENTREGA",
            "Ocorrencia": "Atraso na entrega",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "018",
            "Descricao": "NÃO RECEBEU NA DATA AGENDADA",
            "Ocorrencia": "Fora do agendamento",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "021",
            "Descricao": "SISTEMA DO CLIENTE FORA DO AR",
            "Ocorrencia": "Sem Sistema",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "011",
            "Descricao": "EXCESSO DE VEICULOS",
            "Ocorrencia": "Excesso de Veiculos",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "995",
            "Descricao": "Rota cancelada pelo console",
            "Ocorrencia": "Rota Cancelada",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "016",
            "Descricao": "CARGA NÃO COUBE NO VEÍCULO",
            "Ocorrencia": "Excesso de carga",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "tempo_limite_e",
            "Descricao": "Motorista ficou esperando mais que o tempo limite de espera",
            "Ocorrencia": "Tempo de espera excedido",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        },
        {
            "Codigo": "05x",
            "Descricao": "Ocorrência de não entrega com outros detalhes/restrições",
            "Ocorrencia": "Não entrega - Outros",
            "GeraDevolucao": "Não",
            "FotoObrigatoria": "Não",
            "AnotacaoObrigatoria": "Não",
            "AssinaturaObrigatoria": "Não"
        }
    ]
}