API · Etiquetas e envios
Romaneio de coleta pelo XML da NF-e via API
Relação das notas, volumes, pesos e valores para entregar à transportadora, com espaço para placa, motorista e assinaturas. Integre no seu sistema com uma chamada: POST /v1/tools/romaneio-de-coleta.
Custo1 crédito por arquivo
TipoLeve
Arquivos1 ou mais
Formatosxml, zip
Exemplo
curl -X POST "https://convertaja.com.br/v1/tools/romaneio-de-coleta?wait=true" \
-H "Authorization: Bearer $CONVERTAJA_KEY" \
-F "files=@arquivo1.xml" \
-F 'options={"sort":"destinatario"}'import { openAsBlob } from 'node:fs';
const form = new FormData();
form.append('files', await openAsBlob('arquivo1.xml'), 'arquivo1.xml');
form.append('options', JSON.stringify({"sort":"destinatario"}));
const res = await fetch('https://convertaja.com.br/v1/tools/romaneio-de-coleta?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/romaneio-de-coleta",
params={"wait": "true"},
headers={"Authorization": f"Bearer {os.environ['CONVERTAJA_KEY']}"},
files=[("files", open("arquivo1.xml", "rb"))],
data={"options": json.dumps({"sort": "destinatario"})},
)
job = res.json()
print(job["status"], job.get("outputs"))<?php
$ch = curl_init('https://convertaja.com.br/v1/tools/romaneio-de-coleta?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.xml'),
'options' => json_encode(['sort' => 'destinatario']),
],
]);
$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 |
|---|---|---|---|
transportadora | string | Transportadora (vazio = a que está nas notas) | — |
placa | string | Placa do veículo | — |
data | string | Data da coleta | — |
motorista | string | Motorista (vazio = preencher à mão) | — |
sort | string | Ordem das notasnumero Número · destinatario Destinatário · cidade Cidade | "numero" |
Com arquivo por URL (JSON)
curl -X POST "https://convertaja.com.br/v1/tools/romaneio-de-coleta" \
-H "Authorization: Bearer $CONVERTAJA_KEY" \
-H "Content-Type: application/json" \
-d '{"files":[{"url":"https://seusite.com.br/arquivos/exemplo1.xml"}],"options":{"sort":"destinatario"},"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": "romaneio-de-coleta",
"status": "running",
"progress": 0,
"credits_charged": 1,
"outputs": []
}Prefere sem programar? Use Romaneio de coleta pelo XML da NF-e no site.