API · Etiquetas e envios

Lista de separação (picking) pelo XML da NF-e via API

Envie os XMLs das vendas do dia e receba a lista de produtos somados por SKU para separar no estoque, com caixa para marcar. Integre no seu sistema com uma chamada: POST /v1/tools/lista-de-separacao.

Custo1 crédito por arquivo

TipoLeve

Arquivos1 ou mais

Formatosxml, zip

Exemplo

curl -X POST "https://convertaja.com.br/v1/tools/lista-de-separacao?wait=true" \
  -H "Authorization: Bearer $CONVERTAJA_KEY" \
  -F "files=@arquivo1.xml" \
  -F 'options={"group":"ean","sort":"descricao"}'

import { openAsBlob } from 'node:fs';

const form = new FormData();
form.append('files', await openAsBlob('arquivo1.xml'), 'arquivo1.xml');
form.append('options', JSON.stringify({"group":"ean","sort":"descricao"}));

const res = await fetch('https://convertaja.com.br/v1/tools/lista-de-separacao?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/lista-de-separacao",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['CONVERTAJA_KEY']}"},
    files=[("files", open("arquivo1.xml", "rb"))],
    data={"options": json.dumps({"group": "ean", "sort": "descricao"})},
)
job = res.json()
print(job["status"], job.get("outputs"))

<?php
$ch = curl_init('https://convertaja.com.br/v1/tools/lista-de-separacao?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(['group' => 'ean', 'sort' => 'descricao']),
  ],
]);
$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
`group`	string	Juntar os produtos iguais por `codigo` Código (SKU) · `ean` Código de barras (EAN) · `descricao` Descrição	`"codigo"`
`sort`	string	Ordem da lista `codigo` Por código · `descricao` Por descrição · `quantidade` Maior quantidade	`"codigo"`
`orders`	boolean	Resumo por pedido (o que vai em cada pacote)	`true`
`xlsx`	boolean	Planilha Excel além do PDF	`false`

Com arquivo por URL (JSON)

curl -X POST "https://convertaja.com.br/v1/tools/lista-de-separacao" \
  -H "Authorization: Bearer $CONVERTAJA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"files":[{"url":"https://seusite.com.br/arquivos/exemplo1.xml"}],"options":{"group":"ean","sort":"descricao"},"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": "lista-de-separacao",
  "status": "running",
  "progress": 0,
  "credits_charged": 1,
  "outputs": []
}

Prefere sem programar? Use Lista de separação (picking) pelo XML da NF-e no site.

Lista de separação (picking) pelo XML da NF-e via API

Exemplo

Opções

Com arquivo por URL (JSON)

Resposta

Outras ferramentas de Etiquetas e envios