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

Consultar e manter um representante

Consulta, atualiza (de forma parcial), exclui e reativa um representante comercial.

Consultar um representante

GET/api/v1/admin/trade-reps/{id}Admin

Consulta um representante

Parâmetros de caminho

idintegerobrigatório
Id do representante (inteiro).

Devolve o mesmo objeto da lista.

Atualizar um representante

Apesar de ser PUT, a atualização é parcial: só os campos enviados mudam. Para limpar um texto mande ""; para limpar owner_vendor_id mande "".

PUT/api/v1/admin/trade-reps/{id}Admin

Atualiza campos de um representante

Parâmetros de caminho

idintegerobrigatório
Id do representante.

Corpo da requisição

namestring
Nome.
emailstring
Novo e-mail (validado e normalizado). Atualiza só o cadastro do representante, não o e-mail de login.
phonestring
Telefone.
regionstring
Território, texto livre.
regional_codestring
Regional de distribuição. Validada contra as regionais da loja.
statesarray
Lista completa de estados.
is_activeboolean
false desativa. true num representante que excluiu a própria conta o reativa de verdade, restaurando o login.
commission_rateinteger
Comissão em pontos-base.
notesstring
Observações internas.
owner_vendor_idstring
Seller dono. "" volta ao modo marketplace.
internal_codestring
Código interno.
hierarchy_levelinteger
01234
Nível hierárquico.
discount_limit_bpinteger
Alçada de desconto, em pontos-base.
destination_idsarray
Lista completa de destinos.
passwordstring
Nova senha do login vinculado. Não vazia para ter efeito.
usergroup_idsarray
Grupos de privilégio a acrescentar ao login (não remove os atuais).
bash
curl -X PUT "$BASE_URL/api/v1/admin/trade-reps/31" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"discount_limit_bp": 300, "states": ["SP", "RJ"]}'

A resposta é o representante atualizado (200).

Excluir um representante

DELETE/api/v1/admin/trade-reps/{id}Admin

Exclui um representante e seus vínculos

Parâmetros de caminho

idintegerobrigatório
Id do representante.
200Excluído
json
{ "status": "deleted" }
Exclusão definitiva, sempre com 200

A exclusão apaga o representante, as comissões, os sellers atendidos e a carteira dele. Não há como desfazer e o login dele não é apagado. A resposta é 200 mesmo para um id que nunca existiu. Para só tirar de operação, use PUT com "is_active": false.

Reativar uma conta excluída pelo próprio representante

O representante pode excluir a própria conta pelo app (exclusão reversível). Esta rota reabre o cadastro, restaura o usuário de login e devolve o representante com reactivated_at. É idempotente: chamar para um representante já ativo devolve o cadastro sem mudar nada.

POST/api/v1/admin/trade-reps/{id}/reactivateAdmin

Reativa a conta de um representante

Parâmetros de caminho

idintegerobrigatório
Id do representante.

Erros

StatusQuandoCorpo de exemplo
400id não é inteiro.{"error":"invalid trade rep ID"}
400Corpo do PUT não é JSON, e-mail inválido, senha fraca.{"error":"traderep_email_invalid","detail":"..."}
404Representante não existe (consulta, PUT, reativação).{"error":"trade rep not found"}
409PUT com password/usergroup_ids em conta que não é de seller.{"error":"email_in_use","detail":"..."}
401 / 403Sem token, módulo desligado ou sem privilégio.{"error":"module_disabled","module":"trade-reps"}
Trocar o e-mail do cadastro não troca o login

O PUT com email altera o e-mail do representante, mas o usuário de login continua com o e-mail antigo. Para mudar o acesso, use as rotas de usuário.

Veja também

  • Listar e criar
  • Visão geral
Anterior
Listar e criar representantes
Próxima
Carteira de clientes
Nesta página
  • Consultar um representante
  • Atualizar um representante
  • Excluir um representante
  • Reativar uma conta excluída pelo próprio representante
  • Erros
  • Veja também