Ir para o conteúdo

Consulta de Frete

GET https://freterapido.com/api/external/embarcador/v1/quote/find?order_number=[order_number]&invoice_key=[invoice_key]&invoice_number=[invoice_number]&invoice_serie=[invoice_serie]&codigo_volume=[codigo_volume]&token=[seu_token]

Método que permite consultar as informações de um determinado frete por mais de um parâmetro.

Serão retornados os dados disponíveis sobre o frete.

Observações:

Por regra da API, você só deve informar apenas um identificador único para a localização do frete, seja ele o número do pedido ou os dados da NF-e.

  • Em casos que houverem mais de um frete com o mesmo número do pedido, será retornado o frete mais recente;
  • Em casos em que a busca seja realizada pela NF-e, a API optará primeiro pela busca através da chave de acesso, caso não seja informada, a busca será feita pelo número e série da NF-e. Nesses casos, assim como o número do pedido, será retornado o frete mais recente;

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
order_number Número do pedido contratado na Frete Rápido String Opcional
parent_order_number Número do Pedido Pai de um frete contratado na Frete Rápido String Opcional
invoice_key Chave de acesso da nota fiscal String Numérica Opcional
invoice_number Número da nota fiscal String Numérica Opcional
invoice_serie Série da nota fiscal String Numérica Obrigatório se informado invoice_number
codigo_volume Código de rastreio do volume, nesse caso retornarão apenas os dados do volume especificado String Opcional
token Token de integração String *

*Obrigatório

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com os dados do frete consultado.
Nome
 Descrição Formato / Exemplo Retornado
id_frete Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete. String de 13 caracteres Sempre
url_rastreio URL de rastreio do frete contratado na Frete Rápido String Sempre
numero_pedido_pai Número do Pedido Pai na loja String Sempre
numero_pedido Número do pedido na loja String Sempre
data_pedido Data de criação do pedido na loja Datetime (YYYY-MM-DD HH:mm:ss) Eventual
data_faturamento Data de faturamento do pedido na loja Datetime (YYYY-MM-DD HH:mm:ss) Eventual
data_prevista_entrega Data prevista de entrega calculada 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
forma_pagamento Forma de pagamento do pedido String Eventual
obs_cliente Observação(texto livre) do cliente sobre o pedido String Eventual
data_contratacao Data e hora da contratação do frete Datetime: YYYY-MM-DD hh:mm:ss Sempre
tipo_cobranca Tipo de cobrança selecionado para o frete (CIF ou FOB) String Sempre
modal Modalidade do frete (Rodoviário, Aéreo) String Sempre
data_coleta Data de possível coleta informada pelo remetente Date: YYYY-MM-DD Eventual
referencia_tabela Referência da tabela String Sempre
embarcador Objeto com os dados de endereço do remetente Objeto em json Sempre
 cnpj CNPJ do remetente da carga String numérica com formatação Sempre
 inscricao_estadual Inscrição Estadual do remetente da carga String Sempre
 razao_social Razão social do remetente String Sempre
 nome_fantasia Nome fantasia do remetente String Sempre
 endereco Objeto com os dados de endereço do remetente Objeto em json Sempre
  rua Logradouro do remetente String Sempre
  numero Número do local do remetente String Sempre
  complemento Complemento do endereço (se houver) String Eventual
  bairro Bairro do remetente String Sempre
  cidade Cidade do remetente String Sempre
  estado Estado do remetente String Sempre
  cep CEP do remetente da carga String com formatação Sempre
estimated_date Prazo de entrega original devolvido pela transportadora em cotação, contado a partir da data da cotação. Date: YYYY-MM-DD Eventual
prazo_original_transportador Prazo de entrega original devolvido pela transportadora em cotação, contado a partir da coleta/postagem do pedido. Date: YYYY-MM-DD Eventual
destinatario Objeto com dados do destinatário da carga Objeto em json Sempre
 cnpj_cpf CNPJ ou CPF do destinatário da carga String numérica com formatação Sempre
 nome Nome ou Razão Social do destinatário String de até 255 caracteres Sempre
 endereco Objeto com os dados de endereço do destinatário Objeto em json Sempre
  rua Logradouro do destinatário String Sempre
  numero Número do local do destinatário String Eventual
  complemento Complemento do endereço (se houver) String Eventual
  bairro Bairro do destinatário String Eventual
  cidade Cidade do destinatário String Sempre
  estado Estado do destinatário String Sempre
  cep CEP do destinatário String Sempre
expedidor Objeto com os dados do expedidor Objeto em json Eventual
 cnpj CNPJ do expedidor da carga String numérica com formatação Eventual
 inscricao_estadual Inscrição Estadual do expedidor da carga String Eventual
 razao_social Razão social do expedidor String Eventual
 nome_fantasia Nome fantasia do expedidor String Eventual
 endereco Objeto com os dados de endereço do expedidor Objeto em json Eventual
  rua Logradouro do expedidor String Eventual
  numero Número do local do expedidor String Eventual
  complemento Complemento do endereço (se houver) String Eventual
  bairro Bairro do expedidor String Eventual
  cidade Cidade do expedidor String Eventual
  estado Estado do expedidor String Eventual
  cep CEP do expedidor da carga String com formatação Eventual
volumes Array com um ou mais objetos dos volumes informados Array em json Sempre
Objeto com as características do volume informado Objeto em json Sempre
 tipo Tipo do volume informado String Sempre
 sku SKU do volume informado String Eventual
 descricao Descrição do volume informado String Eventual
 quantidade Quantidade de volumes iguais e do mesmo tipo Numérico (inteiro) Sempre
 peso_total Peso total (em Kg) da quantidade de volumes informados. Exemplo: 6 volumes com 0.5 Kg cada, então o valor informado deve ser 3 Kg Numérico (float) Sempre
 valor_total Valor total da quantidade de volumes informados. Exemplo: 6 volumes custando R$20,00 cada, então o valor informado deve ser R$120,00 Numérico (float) Sempre
 altura Altura em metros do volume unitário Numérico (float) Sempre
 largura Largura em metros do volume unitário Numérico (float) Sempre
 comprimento Comprimento em metros do volume unitário Numérico (float) Sempre
transportadora Objeto com os dados da transportadora Objeto em json Sempre
 cnpj CNPJ da transportadora String numérica com formatação Sempre
 razao_social Razão social da transportadora String Sempre
 nome_fantasia Nome fantasia da transportadora String Sempre
 inscricao_estadual Inscrição Estadual da transportadora String Sempre
 servico Serviço informado na resposta da cotação de frete, referente ao cadastrado na tabela de frete String Sempre
 valor_cotado Valor do Frete Contratado Numérico (float) Sempre
 endereco Objeto com os dados de endereço da transportadora Objeto em json Sempre
  cep CEP da transportadora String numérica Sempre
  bairro Bairro da transportadora String Sempre
  rua Logradouro da transportadora String Sempre
  numero Número da transportadora String Eventual
  complemento Complemento do endereço (se houver) String Eventual
  cidade Cidade da transportadora String Sempre
  estado Estado da transportadora String Sempre
codigos Objeto com os Códigos Objeto em json Sempre
 correios Códigos dos Correios Array com um ou mais objetos dos correios Eventual
 transportadora Códigos das transportadoras Array com um ou mais objetos das transportadoras Eventual
 redespacho Códigos de redespachos Array com um ou mais objetos de redespacho Eventual
ultimo_status Objeto com os dados do último status do frete Objeto em json Sempre
 codigo Código numérico da ocorrência na Frete Rápido Numérico (inteiro) Sempre
 nome Nome da ocorrência String Sempre
 data_ocorrencia Data da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
 data_atualizacao Data de atualização da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
 data_reentrega Data em caso de nova tentativa de entrega Date (YYYY-MM-DD) Em caso de reentrega
 prazo_devolucao Quantidade de dias úteis para devolução da carga/mercadoria String Em caso de devolução
 mensagem Mensagem livre para informação pela transportadora String até 255 caracteres Eventual
nfe Array com um ou mais objetos de NF-e anexadas ao frete Array Sempre
Objeto com os dados da NF-e Objeto em json Eventual
 chave_acesso Chave de acesso da nota fiscal String Numérica Eventual
 data_emissao Data de emissão da nota fiscal Numérico (float) Eventual
 numero Número da nota fiscal String Numérica Eventual
 serie Série da nota fiscal String Numérica Eventual
 valor Valor descrito na nota fiscal Numérico (float) Eventual
 valor_itens Valor total dos itens descritos na nota fiscal Numérico (float) Eventual
 quantidade_volumes Quantidade de volumes descritos na nota fiscal String Numérica Eventual
cte Array com um ou mais objetos de CT-e anexados ao frete Array Sempre
Objeto com os dados do CT-e Objeto em json Eventual
 chave_acesso Chave de acesso do conhecimento de transporte String Numérica Eventual
 protocolo Número do Protocolo da CT-e na SEFAZ String Opcional
 numero Número do conhecimento de transporte String Numérica Eventual
 serie Série do conhecimento de transporte String Numérica Eventual
 valor Valor descrito no conhecimento de transporte Numérico (float) Eventual
 data_emissao Data e hora de emissão do Conhecimento pela transportadora DateTime ("YYYY-MM-DD hh:mm:ss") Sempre
 processamento Data e hora do processamento do EDI na transportadora DateTime ("YYYY-MM-DD hh:mm:ss") Eventual
ocorrencias Array com um ou mais objetos de ocorrências anexados ao frete Array Sempre
Objeto com os dados da ocorrência Objeto em json Eventual
 codigo Código numérico da ocorrência na Frete Rápido Numérico (inteiro) Sempre
 nome Nome da ocorrência String Sempre
 data_ocorrencia Data da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
 data_atualizacao Data de atualização da ocorrência Datetime (YYYY-MM-DD hh:mm:ss) Sempre
 data_prevista_entrega Data prevista de entrega calculada 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
 data_reentrega Data em caso de nova tentativa de entrega Date (YYYY-MM-DD) Em caso de reentrega
 prazo_devolucao Quantidade de dias úteis para devolução da carga/mercadoria String Em caso de devolução
 mensagem Mensagem livre para informação pela transportadora String até 255 caracteres Eventual
 razao_social_transportadora Razão social da transportadora na ocorrência String até 255 caracteres Sempre
 descricao_ocorrencia Descrição da ocorrência na transportadora no momento da atualização String até 255 caracteres Eventual
 codigo_ocorrencia Código da ocorrência na transportadora no momento da atualização Inteiro Eventual
 nome_entregador Nome do entregador responsável pela ocorrência String até 50 caracteres Eventual
 cnpj_cpf_entregador CNPJ/CPF do entregador responsável pela ocorrência String até 14 caracteres Eventual
 comprovantes Comprovantes da ocorrência Array com nenhum ou vários comprovantes Eventual
 codigos_redespacho Códigos de redespacho da ocorrência Array com nenhum ou vários códigos Eventual
 codigo_volume Código de rastreio do volume String Eventual
metadados Array de objetos contendo chave e valor com as informações adicionais da contratação Array Opcional
Objeto com os dados do metadados Objeto em json contendo até 64 itens Eventual
 chave Nome do atributo de informação extra da solicitação de coleta, que são informadas pelo embarcador, deve ser nome único para chave String de até 255 caracteres Se houver metadados
 valor Corresponde ao valor do atributo da chave informada String de até 255 caracteres Se houver metadados

Exemplo: 

    {
      "id_frete": "",
      "url_rastreio": "",
      "numero_pedido_pai": "",
      "numero_pedido": "",
      "data_pedido": "",
      "data_faturamento      ": "",
      "data_prevista_entrega": "",
      "forma_pagamento": "",
      "obs_cliente": "",
      "data_contratacao": "",
      "tipo_cobranca": "",
      "modal": "",
      "data_coleta": "",
      "embarcador": {
        "cnpj": "",
        "inscrição_estadual": "",
        "razao_social": "",
        "nome_fantasia": "",
        "endereco": {
          "rua": "",
          "numero": "",
          "complemento": "",
          "bairro": "",
          "cidade": "",
          "estado": "",
          "cep": ""
        }
      },
      "estimated_date": "", 
      "prazo_original_transportador": "", 
      "destinatario": {
        "cnpj_cpf": "",
        "nome": "",
        "endereco": {
          "rua": "",
          "numero": "",
          "complemento": "",
          "bairro": "",
          "cidade": "",
          "estado": "",
          "cep": ""
        }
      },
      "expedidor": {
        "cnpj": "",
        "inscricao_estadual": "",
        "razao_social": "",
        "nome_fantasia": "",
        "endereco": {
            "rua": "",
            "numero": "",
            "complemento": "",
            "bairro": "",
            "cidade": "",
            "estado": "",
            "cep": ""
        }
    },
      "volumes": [
        {
          "tipo": "",
          "sku": "",
          "descricao": "",
          "quantidade": 0,
          "peso_total": 0.00,
          "valor_total": 0.00,
          "altura": 0.00,
          "largura": 0.00,
          "comprimento": 0.00,
          "volumes_produto": 0,
          "itens": []
        }
      ],
      "transportadora": {
        "cnpj": "",
        "razao_social": "",
        "nome_fantasia": "",
        "inscricao_estadual": "",
        "servico": "",
        "valor_cotado": 0.00,
        "endereco": {
          "cep": "",
          "bairro": "",
          "rua": "",
          "numero": "",
          "complemento": "",
          "cidade": "",
          "estado": ""
        }
      },
      "codigos": {
        "correios":[""],
        "transportadora": [""],
        "redespacho": [""]
      },
      "ultimo_status": {
        "codigo": 0,
        "nome": "",
        "data_ocorrencia": "",
        "data_atualizacao": "",
        "data_reentrega": "",
        "prazo_devolucao": "",
        "mensagem": ""
      },
      "nfe": [
        {
          "chave_acesso": "",
          "data_emissao": "",
          "numero": "",
          "serie": "",
          "valor": 0.00,
          "valor_itens": 0.00,
          "quantidade_volumes": 0
        }
      ],
      "cte": [
        {
          "chave_acesso": "0",
          "protocolo": "",
          "numero": "0",
          "serie": "0",
          "valor": 0.00,
          "data_emissao": "",
          "processamento": ""
        }
      ],
      "ocorrencias": [
        {
           "codigo": 0,
           "nome": "",
           "data_ocorrencia": "",
           "data_atualizacao": "",
           "data_prevista_entrega": "",
           "data_reentrega": "",
           "prazo_devolucao": "",
           "mensagem": "",
           "razao_social_transportadora": "",
           "descricao_ocorrencia": "",
           "codigo_ocorrencia": 0,
           "nome_entregador": "",
           "cnpj_cpf_entregador": "",
           "comprovantes": [],
           "codigos_redespacho": [],
           "codigo_volume": ""
        },
        {
           "codigo": 1,
           "nome": "",
           "data_ocorrencia": "",
           "data_atualizacao": "",
           "data_prevista_entrega": "",
           "data_reentrega": "",
           "prazo_devolucao": "",
           "mensagem": "",
           "razao_social_transportadora": "",
           "descricao_ocorrencia": "",
           "codigo_ocorrencia": 0,
           "nome_entregador": "",
           "cnpj_cpf_entregador": "",
           "comprovantes": [],
           "codigos_redespacho": [],
           "codigo_volume": ""
        }
      ],
      "metadados": [
        {
          "chave": "",
          "valor": ""
        }
      ]
    }

Erro:

Voltar ao topo