Ir para o conteúdo

Ocorrências por Nota Fiscal

GET https://freterapido.com/api/external/embarcador/v1/quotes/occurrences/invoices?token=[seu_token]&invoices=[{"key":""},{"number":"", "serie":""}]&codigo_volume=[codigo_volume]

Permite consultar todas as ocorrências de rastreio de um frete através do número e série ou da chave de acesso da nota fiscal.

As ocorrências são apresentadas por ordem de acontecimento.

Para evitar gargalos e imprevistos que possam influenciar em sua operação, é permitido informar até 50 notas fiscais (número e série ou chave de acesso).

Basta informar o token de integração e um array de objetos contendo número e série ou chave de acesso da nota fiscal, conforme estrutura abaixo.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
token Token de integração String de 32 caracteres *
invoices Array de objetos podendo ter número e série ou chave de acesso da nota fiscal Array em Json *
 number Número da nota fiscal String Se "serie" não informado
 serie Série da nota fiscal String Se "number" não informado
 key Chave de acesso da nota fiscal String Se não houver "number" e "serie"
codigo_volume Código de rastreio do volume, nesse caso retornarão apenas os dados do volume especificado String Opcional

*Obrigatório

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com os dados de rastreio do frete informado.
Nome
 Descrição Formato / Exemplo Retornado
frete (identificador do frete) Identificador do frete contratado na Frete Rápido Array Sempre
 invoices Array de objetos cotendo o número, série e chave de acesso Array Sempre
  number Número da nota fiscal String Sempre
  serie Série da nota fiscal String Sempre
  key Chave de acesso da nota fiscal String Sempre
 occurrences Array de objetos os registros das ocorrencias do frete Array Sempre
  code Código numérico da ocorrência na Frete Rápido Numérico (inteiro) Sempre
  name Nome da ocorrência String Sempre
  occurrence_date Data da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
  updated_date Data de atualização da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
  attempted_redelivery_date Data em caso de nova tentativa de entrega Date (YYYY-MM-DD) Em caso de reentrega
  expected_delivery_date Data prevista de entrega calculado no ato da cotação, com base nos dias úteis para entrega. Sendo apenas uma referência, podendo ser diferente a depender das operações de cada transportadora. Date (YYYY-MM-DD) Eventual
  return_deadline_date Quantidade de dias úteis para devolução da carga/mercadoria String Em caso de devolução
  message Mensagem livre para informação pela transportadora String até 255 caracteres Eventual
  codigo_volume Código de rastreio do volume String Eventual

Exemplo de resposta:

[
    {
        "FR11111111111": {
            "invoices": [
                {
                    "number": "",
                    "serie": "",
                    "key": ""
                }
            ],
            "occurrences": [
                {
                    "code": 0,
                    "name": "",
                    "occurrence_date": "",
                    "updated_date": "",
                    "attempted_redelivery_date": null,
                    "expected_delivery_date": "",
                    "return_deadline_date": null,
                    "message": null,
                    "codigo_volume": ""
                },
                {
                    "code": 1,
                    "name": "",
                    "occurrence_date": "",
                    "updated_date": "",
                    "attempted_redelivery_date": null,
                    "expected_delivery_date": "",
                    "return_deadline_date": null,
                    "message": null,
                    "codigo_volume": ""
                }
            ]
        }
    }
]

Erro:

Voltar ao topo