Ir para o conteúdo

Smart Label do Frete

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

Método que permite à Transportadora enviar a etiqueta (Smart Label) de um frete identificando-o por mais de um parâmetro, sem precisar do ID Frete Rápido.

A etiqueta pode ser enviada por URL ou em Base64. Os requisitos do arquivo e a regra de sobrescrita são os mesmos de Smart Label do Frete por ID.

Envio:

Parâmetros da URL:

Nome Descrição Formato / Exemplo Obrigatório
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, e exatamente um identificador do frete: parent_order_number, order_number, invoice_access_key ou invoice_number + invoice_series.

Nome Descrição Formato / Exemplo Obrigatório
sender_register_number CNPJ do remetente do frete (Expedidor ou Embarcador) String Alfanumérica de 14 caracteres sem formatação *
order_number Número do pedido contratado na Frete Rápido String Um identificador
parent_order_number Número do Pedido Pai de um frete contratado na Frete Rápido String Um identificador
invoice_access_key Chave de acesso da NF-e String de 44 dígitos Um identificador
invoice_number Número da NF Numérico (inteiro) Um identificador (com invoice_series)
invoice_series Série da NF Numérico (inteiro) Obrigatório com invoice_number
url Link do PDF da etiqueta String (URL pública, https) url ou base64
base64 Conteúdo do PDF da etiqueta codificado em Base64 String Base64 url ou base64

* Dados Obrigatórios

Exemplo de envio com URL:

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

Exemplo de envio com Base64:

    {
        "sender_register_number": "",
        "invoice_access_key": "",
        "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 (mais de um ou nenhum identificador do frete, ou nenhum/os dois entre url e base64)
500 Erro interno ao processar a etiqueta
Voltar ao topo