Listar itens do lote

Retorna a lista paginada dos itens de um lote, com filtros por classificação e status.

GEThttps://external-api.arbitralis.com.br/api/external/v1/notifications/batches/{batchId}/items

AutenticaçãoX-API-KEYSíncrono — a resposta já traz o resultado

Retorna as notificações individuais de um lote. Use para reconciliar item a item com a sua base, identificar falhas e obter os itemId necessários para reenvio ou envio individual.

Parâmetros de rota

batchIduuidobrigatório

Identificador do lote.

Query string

classificationstringopcional

Filtra pela classificação do item — por exemplo VALIDO ou INVALIDO.

statusstringopcional

Filtra pelo status do item — por exemplo PENDENTE, ENVIADA, ENTREGUE, FALHA_ENVIO.

pageintegeropcionalpadrão 1

Número da página.

pageSizeintegeropcionalpadrão 20

Itens por página. Máximo 100.

Status dos itens

Status	Significado
`PENDENTE`	Aguardando envio
`ENVIADA`	Despachada em todos os canais
`PARCIALMENTE_ENVIADA`	Despachada em parte dos canais
`ENTREGUE`	Confirmada como entregue
`PARCIALMENTE_ENTREGUE`	Entregue em parte dos canais
`FALHA_ENVIO`	Falhou no despacho
`CANCELADA`	Cancelada antes do envio

O campo nomeDivergente indica que o nome informado não bate com o nome oficial associado ao CPF/CNPJ — vale revisar antes de enviar.

Tratando falhas

Reenviar apenas as falhas

const base = 'https://external-api.arbitralis.com.br/api/external/v1';
const headers = { 'X-API-KEY': apiKey, 'Content-Type': 'application/json' };

const listagem = await fetch(
  `${base}/notifications/batches/${batchId}/items?status=FALHA_ENVIO&pageSize=100`,
  { headers }
);

const { data } = await listagem.json();

if (data.total > 0) {
  await fetch(`${base}/notifications/batches/${batchId}/resend`, {
    method: 'POST',
    headers,
    body: JSON.stringify({ onlyFailed: true }),
  });
}

Erros de validação em massa

Para revisar todos os itens inválidos de uma vez em uma planilha, use Exportar erros em CSV — uma única requisição devolve o relatório completo, sem paginação.

Erros

Código	Causa
`400`	Parâmetros de consulta inválidos
`401`	API key ausente, inválida ou inativa
`404`	Lote não encontrado neste workspace
`429`	Limite de requisições excedido

Requisição

curl -X GET "https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/items?classification=INVALIDO&page=1&pageSize=100" \
  -H "X-API-KEY: arb_live_SUA_CHAVE"

const batchId = '1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d';
const params = new URLSearchParams({ status: 'FALHA_ENVIO', pageSize: '100' });

const response = await fetch(
  `https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/${batchId}/items?${params}`,
  { headers: { 'X-API-KEY': 'arb_live_SUA_CHAVE' } }
);

const { data } = await response.json();
const idsComFalha = data.items.map((item) => item.id);

import requests

batch_id = "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

response = requests.get(
    f"https://external-api.arbitralis.com.br/api/external/v1/notifications/batches/{batch_id}/items",
    headers={"X-API-KEY": "arb_live_SUA_CHAVE"},
    params={"classification": "INVALIDO", "pageSize": 100},
)

data = response.json()["data"]

Resposta

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
        "loteId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "status": "ENTREGUE",
        "classificacao": "VALIDO",
        "valor": 1500.75,
        "erros": [],
        "nomeDivergente": false,
        "dataCriacao": "2026-08-07T14:32:10.000Z"
      },
      {
        "id": "8d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a",
        "loteId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "status": "PENDENTE",
        "classificacao": "INVALIDO",
        "valor": 890.0,
        "erros": ["CPF/CNPJ inválido"],
        "nomeDivergente": false,
        "dataCriacao": "2026-08-07T14:32:10.000Z"
      }
    ],
    "total": 250,
    "page": 1,
    "pageSize": 100,
    "totalPages": 3,
    "hasNext": true,
    "hasPrevious": false
  }
}