VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Central de pendências

Fila única de pendências do time administrativo: aprovações, moderações e análises criadas automaticamente, com atribuição, adiamento e conclusão.

A central de pendências é a fila única de tudo o que precisa de uma pessoa do time administrativo. Você não cria pendências pela API: a plataforma as abre sozinha quando um evento acontece (um cadastro de cliente que espera aprovação, um produto para moderar, uma devolução solicitada) e as fecha sozinha quando o evento que resolve acontece. A API serve para ler a fila e para organizar o trabalho: pegar, atribuir, adiar, concluir e reabrir.

Pontos principais
  • Ler e pegar exigem view_tasks (ou manage_tasks); atribuir, adiar, concluir e reabrir exigem manage_tasks.
  • Há no máximo uma pendência ativa por tipo e registro: um evento repetido não duplica.
  • O prazo (due_at) é a criação mais o SLA: 48 horas por padrão, configurável por tipo.
  • Várias ações respondem 200 mesmo sem mudar nada; confira a lista depois.

Como funciona

Estados e transições:

open→in_progress→done
EstadoSignificado
openAberta, sem responsável.
in_progressTem responsável (pegou ou foi atribuída).
snoozedAdiada até snoozed_until (no máximo 30 dias).
doneResolvida, manualmente ou pelo fechamento automático.
cancelledEstado previsto no modelo; nenhuma rotina da plataforma o define hoje. Se existir, pode ser reaberta.
TipoOrigem
product_moderationProduto de seller aguardando moderação.
return_requestDevolução solicitada.
review_moderationAvaliação aguardando moderação.
pending_userCadastro de cliente aguardando aprovação.
kyc_reviewAnálise de documentos (KYC).
order_approvalPedido que exige aprovação.
chargebackContestação de pagamento.
rfqPedido de cotação.

Conceitos principais

Prazo e SLA

Cada pendência nasce com due_at igual à criação mais o SLA do tipo. O padrão é 48 horas; a loja pode definir outro valor por tipo. Atrasada é a pendência open ou in_progress com due_at no passado.

Fechamento automático

Quando o evento que resolve acontece (produto aprovado ou rejeitado, cadastro aprovado, pedido aprovado...), a plataforma conclui a pendência. Por isso a resolução é feita na tela de origem (link), não nesta API.

Título não é texto

title é um código estável igual ao tipo. Monte a frase na sua interface a partir de type e metadata.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/tasksLista as pendências, as que vencem primeiro no topoConsultar pendências
GET/api/v1/admin/tasks/summaryContagem de pendências abertas e atrasadas por tipo e por responsávelConsultar pendências
POST/api/v1/admin/tasks/{id}/claimAssume uma pendência sem responsávelAgir nas pendências
POST/api/v1/admin/tasks/{id}/assignAtribui a pendência a um usuário (gestor)Agir nas pendências
POST/api/v1/admin/tasks/{id}/snoozeAdia uma pendência por até 30 diasAgir nas pendências
POST/api/v1/admin/tasks/{id}/doneMarca como resolvidaAgir nas pendências
POST/api/v1/admin/tasks/{id}/reopenReabre uma pendênciaAgir nas pendências

Erros comuns

  • Tentar criar pendências por POST /admin/tasks: a rota não existe; elas nascem de eventos.
  • Interpretar 409 de claim só como "já tem dono": ele também é devolvido para id inexistente ou fora de open/snoozed.
  • Enviar snooze com mais de 30 dias: responde 422.
  • Usar title como texto de tela.
  • Confiar no 200 de done, assign ou reopen como prova de mudança.
  • Mandar corpo malformado em assign e remover o responsável sem querer.

Próximos passos

Consultar pendências
Lista e resumo.
Agir nas pendências
Pegar, atribuir, adiar, concluir.
Anterior
Duplicar e validar
Próxima
Consultar pendências
Nesta página
  • Como funciona
  • Conceitos principais
  • Prazo e SLA
  • Fechamento automático
  • Título não é texto
  • Endpoints
  • Erros comuns
  • Próximos passos