Etiquetas
POST https://freterapido.com/api/external/embarcador/v1/labels?token=[seu_token]&layout=[layout_da_etiqueta]&formato=[nome_do_formato]®erar_etiqueta=[true_ou_false]
Método que permite gerar as etiquetas de um determinado frete.
Serão retornado os dados disponíveis sobre uma etiqueta. Basta informar o id do frete ou chave da Nota Fiscal do frete ou número do pedido.
Observações:
-
Você pode requisitar a geração de várias etiquetas de uma vez ou unitariamente à medida que precisar.
-
Por regra da API, você só deve informar apenas um identificador por agrupamento de fretes. Ou seja, apenas “id_frete”, “chave_nf” ou “numero_pedido”.
-
Não é possível requisitar etiquetas de modelos diferentes no mesmo grupo de frete, por exemplo: Correios e Transportadoras juntos no mesmo grupo “id_frete”. Será retornado uma mensagem de erro pela API.
-
Recomendamos você requisitar a geração de etiquetas por cada tipo de envio (transportadoras diferentes), por exemplo: solicitar as etiquetas dos Correios separadamente das etiquetas de Transportadoras. Os layouts são diferentes.
Observações etiquetas Correios:
- Ao requisitar a geração de várias etiquetas dos Correios de uma vez, serão agrupadas todas essas em uma única PLP (dos Correios) por cada ponto de coleta (expedidor).
Observações etiquetas Multi-origens:
-
Caso você possua vários pontos de coleta (expedidores/origem) para os seus envios, a Frete Rápido irá agrupar o retorno das etiquetas por cada ponto de coleta. Ou seja, o agrupamento de etiquetas retornado pela API será por cada ponto de coleta (expedidor).
-
Recomendamos você requisitar a geração de etiquetas por cada ponto de coleta (expedidores/origem), por exemplo: etiquetas que serão expedidas por cada CD, ou lojista, ou ponto de retirada.
Observações etiquetas DANFE Simplificado:
- Para gerar as etiquetas DANFE Simplificado, é obrigatório que os dados da nota fiscal do frete tenham sido informados completamente, sendo: Chave de acesso, Número da nota, Série da nota, Data de emissão, Tipo de operação, Tipo de emissão e Protocolo de autorização.
Observações etiquetas ZPL:
- A geração de etiqueta ZPL pode ultrapassar 40 segundos a depender da quantidade de volumes do frete.
Envio:
Parâmetros da URL:
| Nome | Descrição | Formato / Exemplo | Obrigatório |
|---|---|---|---|
| token | Token de integração | String de 32 caracteres | * |
| layout | Modelo da etiqueta para impressão | Numérico 1. Correios 2 por A4 ou Frete Rápido 9 por A4 2. Térmica (Correios e Frete Rápido: 10cm x 14cm) 3. Correios e Frete Rápido: 4 por A4 4. Correios e Frete Rápido: 6 por A4 5. Anymarket ZPL2 formato TXT 6. Horizontal (Frete Rápido: 19cm x 5.5 cm) 7. DANFE Simplificado: 4 por A4 (10cm x 10cm) 8. DANFE Simplificado: 4 por A4 (10cm x 14cm) 9. DANFE Simplificado: térmica (10cm x 10cm) 10. DANFE Simplificado: térmica (10cm x 14cm) |
* |
| formato | Formato de download | String contendo "pdf", "zpl" ou "base64" | Opcional, caso não informado, enviará PDF |
| regerar_etiqueta | Flag para regerar etiqueta no layout Frete Rápido em caso de falha | Booleano | Opcional, caso não informado enviará true, exceto Correios que será false |
| * Dados obrigatórios |
Envio:
Parâmetros do corpo da requisição:
| Nome | Descrição | Formato / Exemplo | Obrigatório |
|---|---|---|---|
| id_frete | Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete. | Array de string com 13 caracteres | * |
| chave_nf | Chave de acesso da Nota Fiscal | Array de string com 44 caracteres | * |
| numero_pedido | Número do pedido informado na contratação do frete | Array de string | * |
| *Obrigatório | |||
| Limite de 50 fretes por requisição |
Exemplo de grupos:
[
{
"id_frete": ["...", "..."],
"chave_nf": ["...", "..."],
"numero_pedido": ["...", "..."]
}
]
Exemplo de requisição:
- No exemplo abaixo cada objeto do array é um agrupamento de fretes únicos que não se repetem entre si.
- O mesmo frete não pode estar em agrupamentos diferentes.
[
{
"id_frete": [
"FR000000XXXXX",
"FR000000YYYYY"
]
},
{
"chave_nf": [
"123...321",
"234...654"
]
},
{
"numero_pedido": [
"123456789",
"987654321"
]
}
]
Resposta:
- Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200, juntamente com os dados da tabela abaixo.
| Nome | Descrição | Formato / Exemplo | Retornado |
|---|---|---|---|
| id_frete | Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete. | Array de string com 13 caracteres | Se informado |
| chave_nf | Chave de acesso da Nota Fiscal | Array de string com 44 caracteres | Se informado |
| numero_pedido | Número do pedido informado na contratação do frete | Array de string | Se informado |
| plp | Link de acesso para download da plp | String | Este valor só retornará se a transportadora do frete for Correios |
| etiqueta | Link de acesso para download da etiqueta | String | Sempre |
| erro | Mensagem de erro da geração ou consulta da etiqueta | Array de string | Eventualmente |
| avisos | Objeto, sendo a chave o identificador do frete, e o valor, o problema encontrado ao criar a etiqueta | Objeto em json | Eventualmente |
| origem | Objeto com dados do remetente/origem da carga (Expedidor ou Embarcador) | Objeto em json | * |
| cnpj | CNPJ do remetente da carga | String Numérica de 14 caracteres sem formatação | * |
| endereco | Objeto com dados de endereço do remetente da carga | Objeto em json | * |
| cep | CEP do remetente / origem da carga | String Numérica de 8 caracteres sem formatação | * |
| rua | Logradouro do remetente | String | * |
| numero | Número do local do remetente | String | * |
| bairro | Bairro do remetente | String | * |
| cidade | Cidade do remetente | String | * |
| uf | Estado do remetente | String | * |
| erro_detalhe | Array de objeto contendo os ids e número do pedido com o erro. | Array de objetos em json | Eventualmente |
| id_frete | Identificador do frete contratado na Frete Rápido. | Array de string com 13 caracteres | Sempre |
| erro | Mensagem de erro da geração da etiqueta retornada pela transportadora. | String | Sempre |
| chave_nf | Chave de acesso da Nota Fiscal. | String | Se informado na requisição |
| numero_pedido | Número do pedido informado na contratação do frete. | String | Se informado na requisição |
* Obrigatório
Os links de acesso a PLP e etiqueta terão uma validade de 24h
Exemplo de resposta:
[
{
"id_frete": ["FR000000XXXXX", "FR000000YYYYY"],
"plp": "url_plp_1.pdf",
"etiqueta": "url_etiqueta_1.pdf",
"erro": ["Msg de erro"],
"avisos": {
"FR000000ZZZZZ": "Frete não encontrado"
},
"origem": {
"cnpj": "00000000000000",
"endereco": {
"cep": "00000000",
"rua": "...",
"numero": "...",
"bairro": "...",
"cidade": "...",
"uf": "XX"
}
},
"erro_detalhe": [
{
"id_frete": "FR000000XXXXX",
"erro": "mensagem de erro detalhado da geração da etiqueta",
"numero_pedido": "123456789"
},
{
"id_frete": "FR000000YYYYY",
"erro": "mensagem de erro detalhado da geração da etiqueta",
"chave_nf": "123...321"
}
]
},
{
"chave_nf": ["123...321"],
"plp": "url_plp_2.pdf",
"etiqueta": "url_etiqueta_2.pdf",
"erro": ["Msg de erro"],
"avisos": {
"234...654": "Frete não encontrado"
},
"origem": {
"cnpj": "00000000000000",
"endereco": {
"cep": "00000000",
"rua": "...",
"numero": "...",
"bairro": "...",
"cidade": "...",
"uf": "XX"
}
},
"erro_detalhe": [
{
"id_frete": "FR000000XXXXX",
"erro": "mensagem de erro detalhado da geração da etiqueta",
"numero_pedido": "987654321"
},
{
"id_frete": "FR000000YYYYY",
"erro": "mensagem de erro detalhado da geração da etiqueta",
"chave_nf": "123...321"
}
]
}
]