Listar itens do lote

Retorna a lista paginada dos itens de um lote de negociações, com o status individual de cada um.

GEThttps://external-api.arbitralis.com.br/api/external/v1/extrajudicial/negotiations/batches/{id}/items

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

Retorna os itens de um lote de negociações com o status individual e o negociacaoId criado para cada um. Use para reconciliar a campanha com a sua base e investigar itens que não geraram negociação.

Parâmetros de rota

iduuidobrigatório

Identificador do lote.

Query string

statusstringopcional

Filtra pelo status do item.

valoresPENDINGVALIDATEDPROCESSINGEXISTINGNOT_FOUNDMISSING_PHONEMISSING_VALUECONFLICTERROR

pageintegeropcionalpadrão 1

Número da página.

pageSizeintegeropcionalpadrão 20

Itens por página. Entre 1 e 100.

Status dos itens

Status	Significado	O que fazer
`PENDING`	Aguardando processamento	Aguardar
`VALIDATED`	Validado; negociação criada	Guardar o `negociacaoId`
`PROCESSING`	Em processamento	Aguardar
`EXISTING`	Já existe negociação para a contraparte	Nenhuma — comportamento esperado
`CONFLICT`	Outra negociação ativa usa o mesmo telefone	Verificar se é a mesma pessoa
`NOT_FOUND`	Contraparte não localizada	Revisar os dados de origem
`MISSING_PHONE`	Telefone ausente ou inválido	Corrigir e reenviar
`MISSING_VALUE`	Valor ausente	Corrigir e reenviar
`ERROR`	Falha na validação ou no processamento	Ler `message`

Campos de cada item

Campo	Descrição
`id`	Identificador do item dentro do lote
`status`	Status do item
`negociacaoId`	Negociação criada, ou `null`
`message`	Mensagem de validação ou processamento. Vazio quando não há problema
`createdAt`	Criação do item, em ISO 8601

Reconciliando a campanha

Coletar todas as negociações criadas

async function coletarNegociacoes(batchId, apiKey) {
  const base = 'https://external-api.arbitralis.com.br/api/external/v1';
  const negociacoes = [];
  let page = 1;
  let totalPages = 1;

  do {
    const params = new URLSearchParams({
      status: 'VALIDATED',
      page: String(page),
      pageSize: '100',
    });

    const response = await fetch(
      `${base}/extrajudicial/negotiations/batches/${batchId}/items?${params}`,
      { headers: { 'X-API-KEY': apiKey } }
    );

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

    negociacoes.push(...data.items.map((item) => item.negociacaoId).filter(Boolean));
    totalPages = data.pagination.totalPages;
    page += 1;
  } while (page <= totalPages);

  return negociacoes;
}

O externalId não vem nesta listagem

Para amarrar itens ao identificador do seu sistema, guarde o mapeamento externalId → negociacaoId devolvido na resposta de Criar lote via JSON. Esta listagem trabalha com os identificadores da Arbitralis.

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/extrajudicial/negotiations/batches/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/items?status=ERROR&pageSize=100" \
  -H "X-API-KEY: arb_live_SUA_CHAVE"

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

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

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

for (const item of data.items) {
  console.warn(`Item ${item.id} falhou: ${item.message}`);
}

import requests

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

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

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

Resposta

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "2b3c4d5e-6f7a-4b9c-8d1e-2f3a4b5c6d7e",
        "status": "VALIDATED",
        "negociacaoId": "7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
        "message": "",
        "createdAt": "2026-08-07T14:32:10.000Z"
      },
      {
        "id": "3c4d5e6f-7a8b-4c0d-9e2f-3a4b5c6d7e8f",
        "status": "CONFLICT",
        "negociacaoId": null,
        "message": "Já existe negociação ativa para este telefone",
        "createdAt": "2026-08-07T14:32:10.000Z"
      }
    ],
    "pagination": {
      "total": 250,
      "page": 1,
      "pageSize": 100,
      "totalPages": 3
    }
  }
}