Falhas batch de transações
Referência API
Falhas batch de transações
CSV ou JSON de linhas com falha em job batch de transações.
GET
Falhas batch de transações
Endpoints
…/failures.csv→ download CSV (Content-Disposition: attachment)…/failures→ corpo JSON
Autenticação e permissões
transactions:create, entities:bulk_import, events:create.
Respostas HTTP
| Código | Quando |
|---|---|
200 | Job encontrado (CSV ou JSON) |
401 | Sem autenticação |
403 | Sem permissão batch-import |
404 | jobId inexistente ou de outra organização |
Colunas CSV
| Coluna | Descrição |
|---|---|
external_id | externalId da transação |
code | Código estável — catálogo |
error | Mensagem legível (igual a message no JSON) |
code na DB são normalizados no download quando possível. Se não houver falhas: CSV só com header.
Resposta JSON
| Campo | Tipo | Descrição |
|---|---|---|
success | boolean | Sempre true se o job existe |
jobId | string | Id do job |
kind | string | transaction_batch |
status | string | queued, running, completed, failed, … |
totalItems, succeeded, failed, skipped | number | Contadores do job |
failures | array | { externalId, code, message } |
jobFailure | object | Se o job inteiro falhou: { code, message, details? } (p. ex. INVALID_ENTITY_REFERENCES) |
truncated | boolean | true se há mais de 500 falhas persistidas |
failuresTotal | number | Total de linhas com falha armazenadas |
Com
batchErrorHandling=rollback_all (default), o primeiro erro de insert costuma abortar o batch e não persistir falhas por linha. Use continue_collect_errors ou stop_keep_success para popular este endpoint. Referências de entidade inválidas com validateExistingEntity=true falham o job inteiro (jobFailure), não linhas individuais no CSV.