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

Gerentes de venda

O que é um gerente de venda (representante comercial) na Venddor, como ele se relaciona com clientes e sellers, e o mapa das rotas.

Um gerente de venda (também chamado de representante comercial, trade rep, ou apenas "gerente") é uma pessoa que atende uma carteira de clientes em nome do seller: faz o pedido pelo cliente, negocia desconto dentro de um limite e acompanha o que ele compra. Em lojas B2B e de força de vendas, é a figura que liga o cliente ao seller.

Os gerentes ficam em /api/v1.0/managers, como o módulo de representantes da Venddor 1.0 fazia. São as rotas de integração com ERP e com o app do vendedor.

Pontos-chave
  • Cada gerente tem um login próprio: criar um gerente cria também um usuário do tipo vendor (Clientes) com o mesmo e-mail, telefone e senha.
  • O manager_id é um inteiro (em string), não um UUID. O user_id dentro do gerente é o UUID do usuário.
  • A carteira é a lista de clientes (users) que o gerente atende. Enviar users numa alteração substitui a carteira inteira.
  • Gerente não pode ser excluído pela API: DELETE sempre responde 404. Para desligar um gerente, mude o status para D.
  • O limite de desconto (manager_discount_limit) é um percentual em texto ("7.50" é 7,5%).

Como funciona

O que um gerente carrega

CampoSignificado
name, email, phoneDados do gerente e do login dele.
statusA ativo ou D desativado.
internal_codeCódigo do gerente no seu ERP. Serve para achar o gerente sem guardar o manager_id.
company_idO seller dono do gerente. Vazio quando o gerente é da loja.
ec_user_levelNível na hierarquia comercial (1, 2, 3...), como número.
manager_discount_limitDesconto máximo, em percentual, que o gerente pode conceder.
usersIds dos clientes da carteira.
credit_balanceSaldo de crédito do gerente, em string decimal.
orders_countPedidos do gerente.

Como o gerente se liga aos clientes e ao seller

  • Seller: pelo campo company_id. O gerente enxerga e atende os clientes da carteira dele.
  • Clientes: pela carteira (users). Um cliente na carteira é atendido pelo gerente; o cadastro do cliente continua sendo da loja (Clientes).
  • Login: o usuário vendor criado junto. Na lista de usuários, gerentes que não são donos de seller ficam escondidos por padrão da visão "administradores" (exclude_trade_rep_managers).

Autenticação

HTTP Basic com e-mail:chave_de_api de um administrador, ou Authorization: Bearer <JWT>. Quem não é administrador recebe 403. As rotas também respondem sem o /v1.0 (/api/managers), com ids inteiros: veja Rotas sem versão.

Endpoints

MétodoRotaO que fazAuthPágina
GET/api/v1.0/managersLista gerentesAdminGerenciar gerentes
GET/api/v1.0/managers/{id}Consulta um gerente e a carteiraAdminGerenciar gerentes
POST/api/v1.0/managersCria gerente e loginAdminGerenciar gerentes
PUT/api/v1.0/managers/{id}Altera gerente e carteiraAdminGerenciar gerentes
DELETE/api/v1.0/managers/{id}Não suportado (sempre 404)AdminGerenciar gerentes

Erros comuns

  1. Esperar 201 ou 400 ao criar. A criação responde 200 e, quando falta um campo obrigatório, também 200, com a mensagem em message. Leia o corpo, não só o status.
  2. Enviar senha na alteração esperando trocá-la. A alteração confere se password1 e password2 são iguais, mas não troca a senha. Para trocar a senha, o gerente usa o fluxo "esqueci a senha" da loja.
  3. Reenviar users para "acrescentar" clientes. A lista enviada substitui a carteira. Para acrescentar, leia a carteira, junte e reenvie.
  4. Tentar excluir. DELETE não funciona (404). Mude o status para D.
  5. Alterar um gerente que não existe. A resposta é 200 mesmo assim. Consulte o gerente antes.
  6. Usar o user_id no lugar do manager_id. São ids diferentes: o manager_id é inteiro e é o da URL.

Próximos passos

Gerenciar gerentes
Liste, crie e altere gerentes e a carteira deles.
Clientes
O cadastro dos clientes que o gerente atende.
Grupos de usuários
Segmentos de clientes e privilégios.
Anterior
Rotas sem versão
Próxima
Gerenciar gerentes
Nesta página
  • Como funciona
  • O que um gerente carrega
  • Como o gerente se liga aos clientes e ao seller
  • Autenticação
  • Endpoints
  • Erros comuns
  • Próximos passos