API · Etiquetas e envios

Etiquetas de envio a partir de planilha via API

Gera etiquetas de envio (10×15, 10×10, A4 4 por folha ou adesiva A4 8 por folha) e o romaneio de entregas a partir de uma planilha CSV ou XLSX de pedidos. Linhas com CEP ou UF inválidos são ignoradas e listadas em "info". Integre no seu sistema com uma chamada: POST /v1/tools/etiquetas-envio-planilha.

Custo1 crédito por arquivo

TipoLeve

Arquivosexatamente 1

Formatoscsv, txt, tsv, xlsx, xlsm

Exemplo

curl -X POST "https://convertaja.com.br/v1/tools/etiquetas-envio-planilha?wait=true" \
  -H "Authorization: Bearer $CONVERTAJA_KEY" \
  -F "files=@arquivo1.csv" \
  -F 'options={"size":"100x100","barcode":"pedido"}'

import { openAsBlob } from 'node:fs';

const form = new FormData();
form.append('files', await openAsBlob('arquivo1.csv'), 'arquivo1.csv');
form.append('options', JSON.stringify({"size":"100x100","barcode":"pedido"}));

const res = await fetch('https://convertaja.com.br/v1/tools/etiquetas-envio-planilha?wait=true', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.CONVERTAJA_KEY}` },
  body: form,
});
const job = await res.json();
console.log(job.status, job.outputs);

import json, os, requests

res = requests.post(
    "https://convertaja.com.br/v1/tools/etiquetas-envio-planilha",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['CONVERTAJA_KEY']}"},
    files=[("files", open("arquivo1.csv", "rb"))],
    data={"options": json.dumps({"size": "100x100", "barcode": "pedido"})},
)
job = res.json()
print(job["status"], job.get("outputs"))

<?php
$ch = curl_init('https://convertaja.com.br/v1/tools/etiquetas-envio-planilha?wait=true');
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('CONVERTAJA_KEY')],
  CURLOPT_POSTFIELDS => [
    'files[0]' => new CURLFile('arquivo1.csv'),
    'options' => json_encode(['size' => '100x100', 'barcode' => 'pedido']),
  ],
]);
$job = json_decode(curl_exec($ch), true);
echo $job['status'];

Opções

Envie em options (JSON) ou como campos do formulário. Opções desconhecidas são recusadas com 400 invalid_option.

Opção	Tipo	Descrição e valores	Padrão
`size`	string	Tamanho `100x150` 10 × 15 cm (térmica) · `100x100` 10 × 10 cm · `a4-4` A4, 4 por folha (papel comum) · `a4265` A4 adesiva, 8 por folha (compatível com Pimaco A4265)	`"100x150"`
`barcode`	string	Código de barras (Code 128) `cep` CEP · `pedido` Número do pedido · `nenhum` Sem código de barras	`"cep"`
`romaneio`	string	Gerar o romaneio de entregas (PDF) `sim` Sim · `nao` Não	`"sim"`
`mapping`	string	Colunas da planilha, em JSON (opcional; sem ele as colunas são reconhecidas pelo cabeçalho)	—
`sheet`	string	Aba do Excel (vazio = a primeira)	—
`remetente_nome`	string	Remetente: nome	—
`remetente_documento`	string	Remetente: documento	—
`remetente_endereco`	string	Remetente: endereco	—
`remetente_numero`	string	Remetente: numero	—
`remetente_complemento`	string	Remetente: complemento	—
`remetente_bairro`	string	Remetente: bairro	—
`remetente_cidade`	string	Remetente: cidade	—
`remetente_uf`	string	Remetente: uf	—
`remetente_cep`	string	Remetente: cep	—
`remetente_telefone`	string	Remetente: telefone	—

Com arquivo por URL (JSON)

curl -X POST "https://convertaja.com.br/v1/tools/etiquetas-envio-planilha" \
  -H "Authorization: Bearer $CONVERTAJA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"files":[{"url":"https://seusite.com.br/arquivos/exemplo1.csv"}],"options":{"size":"100x100","barcode":"pedido"},"webhook_url":"https://seusite.com.br/webhooks/convertaja"}'

Resposta

202 com a tarefa (ou 200 já concluída, com ?wait=true). Baixe em outputs[].url ou em download_url (ZIP quando há vários arquivos). Os arquivos ficam disponíveis por 1 hora. Se a tarefa falhar, os crédito volta para o seu saldo.

{
  "id": "V1StGXR8_Z5j",
  "tool": "etiquetas-envio-planilha",
  "status": "running",
  "progress": 0,
  "credits_charged": 1,
  "outputs": []
}

Prefere sem programar? Use Etiquetas de envio a partir de planilha no site.

Etiquetas de envio a partir de planilha via API

Exemplo

Opções

Com arquivo por URL (JSON)

Resposta

Outras ferramentas de Etiquetas e envios