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

Equipe de campo do seller

Como o seller (lojista) cadastra e gerencia os próprios representantes comerciais, a carteira de clientes de cada um, a conta-corrente e os parâmetros financeiros de desconto.

Representante comercial (também chamado de promotor de vendas ou vendedor externo) é a pessoa que atende uma lista de clientes em nome do seller: visita, negocia, lança pedidos pelo aplicativo de campo e recebe comissão. Esta seção é o lado do seller dessa equipe: ele cadastra seus representantes, define quem atende quais clientes e ajusta quanto desconto cada um pode dar. O lado do administrador da loja, que enxerga todas as equipes, está em Representantes comerciais.

Pontos principais
  • Só funciona com o módulo trade-reps ligado na loja. Sem ele, todas as rotas respondem 403 module_disabled.
  • O seller só vê e altera os representantes dele. Um id de representante de outro seller responde 404, e transferir clientes entre representantes de lojas diferentes responde 403.
  • O id do representante é um inteiro (31), não UUID. Clientes e sellers continuam sendo UUID.
  • Descontos e comissões são em pontos-base (500 = 5%); saldo da conta-corrente em centavos.
  • A rota exige um destes privilégios do seller: vendor_manage_trade_reps, vendor_view_trade_reps ou vendor_view_orders. Qualquer um deles libera tanto a leitura quanto a escrita.
  • Criar um representante também cria (ou reaproveita) o login dele como usuário do seller, para entrar no aplicativo de campo.

Como funciona

Cadastrar representante→Montar a carteira→Ajustar alçadas→Acompanhar conta-corrente
  1. Cadastre
    Crie o representante com nome, e-mail e, se o e-mail ainda não tem login, uma senha. Ele já nasce preso ao seu seller.
  2. Monte a carteira
    Consulte a carteira de cada representante e transfira clientes de um para outro quando a equipe mudar. A carteira em si é montada pelo administrador da loja.
  3. Defina as alçadas
    Ajuste o discount_limit_bp de cada representante e os parâmetros financeiros do seller: desconto livre e níveis de aprovação.
  4. Acompanhe
    Veja o extrato da conta-corrente do representante.

Conceitos importantes

Alçada de desconto

Alçada é o limite de desconto que alguém pode conceder sozinho. O representante tem a própria (discount_limit_bp); acima dela o pedido pede aprovação de um nível superior (hierarchy_level, de 1 a 4). Os parâmetros do seller (finance-settings) dizem quanto de excesso cada nível aprova. O pedido fica retido até alguém aprovar.

Conta-corrente

Cada representante tem um saldo em centavos (credit_balance) que ele pode gastar em descontos acima do livre. O extrato lista cada lançamento, com sinal.

Dois modos de operação

No modo do seller (o que esta seção cobre), o representante pertence a um seller (owner_vendor_id). No modo marketplace, o representante atende vários sellers e só o administrador o gerencia; ele não aparece nestas rotas.

Endpoints

MétodoCaminhoPara quêAuth
GET/api/v1/vendor/trade-repsLista os representantes do seller.seller
POST/api/v1/vendor/trade-repsCadastra um representante.seller
GET/api/v1/vendor/trade-reps/{id}Consulta um representante.seller
PUT/api/v1/vendor/trade-reps/{id}Altera um representante.seller
GET/api/v1/vendor/trade-reps/{id}/customersCarteira de clientes do representante.seller
GET/api/v1/vendor/trade-reps/{id}/ledgerExtrato da conta-corrente.seller
POST/api/v1/vendor/trade-reps/transferTransfere clientes entre representantes.seller
GET/api/v1/vendor/trade-reps/finance-settingsLê os parâmetros financeiros do seller.seller
PUT/api/v1/vendor/trade-reps/finance-settingsGrava os parâmetros financeiros.seller

Erros comuns

  • Passar um UUID no lugar do id do representante. O id é inteiro; um valor que não é número é lido como 0 e a resposta é 404 not found.
  • Reaproveitar um e-mail e mandar password. Se já existe usuário seller com esse e-mail, a senha dele é substituída.
  • Mandar PUT /finance-settings só com o campo que mudou. A gravação é completa: os campos omitidos voltam a 0, vazio ou false.
  • Esperar que owner_vendor_id do corpo valha. O servidor ignora e grava o seu seller.
  • Transferir sem customer_ids. Move toda a carteira do representante de origem.
  • Achar que vendor_view_orders só lê. Aqui ele também libera cadastrar, alterar e transferir.

Próximos passos

Cadastro de representantes
Listar, criar e alterar.
Carteira, conta-corrente e alçadas
Clientes, extrato e parâmetros.
Anterior
Verificação KYC
Próxima
Cadastro de representantes
Nesta página
  • Como funciona
  • Conceitos importantes
  • Alçada de desconto
  • Conta-corrente
  • Dois modos de operação
  • Endpoints
  • Erros comuns
  • Próximos passos