Ir para o conteúdo

Smart Label do Frete por ID Frete Rápido

POST https://freterapido.com/api/external/transportadora/v1/quotes/{id_frete}/smart-labels?token={seu_token}

Método que permite à Transportadora enviar a etiqueta (Smart Label) de um frete, quando não foi possível devolvê-la na resposta da Solicitação de Coleta.

A etiqueta pode ser enviada por URL ou em Base64. É aceita uma etiqueta por frete. Veja as regras de Sobrescrita.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
id_frete Identificador único de cada cotação/frete na Frete Rápido. Através deste é possível obter e relacionar todos os outros dados. String de 13 caracteres *
token Token de integração String de 32 caracteres *

* Dados Obrigatórios

Parâmetros do corpo da requisição:

Informe exatamente um entre url e base64.

Nome Descrição Formato / Exemplo Obrigatório
url Link do PDF da etiqueta. O arquivo é baixado no momento em que o Embarcador gera a etiqueta String (URL pública, https) url ou base64
base64 Conteúdo do PDF da etiqueta codificado em Base64 String Base64 url ou base64

Requisitos do arquivo

  • O arquivo deve ser um PDF em layout térmico.
  • Em Base64, arquivos que não forem PDF são rejeitados.
  • Em URL, o link deve continuar acessível. Link inválido, expirado ou que não aponte para um PDF faz a geração da etiqueta falhar para o Embarcador.

Exemplo de envio com URL:

    {
        "url": "https://transportadora.com.br/etiquetas/1.pdf"
    }

Exemplo de envio com Base64:

    {
        "base64": "JVBERi0xLjQK..."
    }

Resposta:

  • Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200. Em caso de erro, será retornado o parâmetro “error”.
Nome Descrição Formato / Exemplo Retornado
error Descrição do erro String Em caso de erro
Status Situação
200 Etiqueta recebida
401 Token não informado ou inválido
403 O frete não pertence à Transportadora do token
404 Transportadora ou frete não encontrado
408 Tempo limite atingido ao processar a etiqueta
415 Arquivo em Base64 não é um PDF
422 Payload inválido (nenhum ou os dois entre url e base64 informados)
500 Erro interno ao processar a etiqueta

Sobrescrita

Um novo envio para o mesmo frete substitui a etiqueta anterior. Somente o arquivo mais recente fica disponível ao Embarcador.

Atenção! Se o Embarcador já tiver impresso a etiqueta anterior, ela deixa de ser válida.

Voltar ao topo