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

Representantes comerciais

O que são representantes comerciais, os dois modos de operação, a carteira de clientes e o mapa das rotas de cadastro, carteira e comissão.

Representante comercial (ou promotor de vendas) é a pessoa que atende uma lista de clientes por conta da loja: visita, negocia, lança pedidos em nome do cliente e recebe comissão. Esta seção cobre o cadastro e a carteira (a lista de clientes que cada representante atende), os sellers que ele atende, as comissões e o desempenho. A parte de campo (rotas de visita, check-ins, conta-corrente, alçada de desconto) está em Campo e alçadas.

Pontos-chave
  • Todas as rotas exigem o módulo trade-reps ligado e o privilégio manage_trade_reps ou manage_vendors. Sem o módulo: 403 module_disabled.
  • O id do representante é inteiro (2, 880001), não UUID. Clientes e sellers continuam sendo UUID.
  • Há dois modos. No modo marketplace (owner_vendor_id vazio) o representante atende vários sellers e ganha comissão por pedido. No modo do seller (owner_vendor_id preenchido) ele é a equipe de campo de uma loja só.
  • Dinheiro é inteiro em centavos; taxas e descontos são pontos-base (500 = 5%).
  • Criar um representante cria (ou reaproveita) também o login dele como usuário do tipo seller. Por isso criar exige senha quando o e-mail ainda não existe.
  • DELETE apaga de verdade e não confere se o id existe. Para desligar, use PUT com is_active: false.

Como funciona

Cadastrar o representante→Montar a carteira→Representante vende→Comissão e conta-corrente
  1. Cadastre

    Crie o representante com nome e e-mail. A plataforma cria o login dele e, no modo do seller, o vincula à equipe do seller.

  2. Monte a carteira

    Atribua clientes um a um, importe uma planilha de CNPJ/CPF, ou transfira a carteira de outro representante.

  3. Acompanhe

    Veja pedidos, resumo e painel e comissões.

Conceitos-chave

Modos: marketplace e seller

No modo marketplace, o vínculo representante-seller fica na tabela de sellers atendidos e a comissão sai por pedido. No modo do seller, a carteira é do próprio seller e o owner_vendor_id limita tudo. A lista aceita mode=seller ou mode=marketplace para separar.

Carteira e tipos de vínculo

Cada vínculo cliente-representante tem um link_kind: permanent (definitivo), temporary (cobertura com data final valid_until, que depois volta ao representante original) ou copy (o cliente fica com os dois). Um cliente pode estar na carteira de mais de um representante.

Nível hierárquico e alçada

hierarchy_level vai de 0 (campo) a 4 (aprovadores). discount_limit_bp é o desconto máximo que o representante dá sozinho. O restante da cadeia está em Campo e alçadas.

Estados e letras

A comissão tem status que, na leitura, sai como letra: P pendente, A aprovada, C paga. Na escrita você manda a palavra (pending, approved, paid).

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/trade-repsListaradmin
POST/api/v1/admin/trade-repsCriaradmin
GET/api/v1/admin/trade-reps/{id}Consultaradmin
PUT/api/v1/admin/trade-reps/{id}Atualizaradmin
DELETE/api/v1/admin/trade-reps/{id}Excluiradmin
POST/api/v1/admin/trade-reps/{id}/reactivateReativar contaadmin
GET/api/v1/admin/trade-reps/{id}/customersListar carteiraadmin
POST/api/v1/admin/trade-reps/{id}/customersAtribuir clienteadmin
DELETE/api/v1/admin/trade-reps/{id}/customers/{customerId}Remover clienteadmin
GET/api/v1/admin/trade-reps/by-customerRepresentante de um clienteadmin
GET/api/v1/admin/trade-reps/issuerEmissor de um clienteadmin
PUT/api/v1/admin/trade-reps/{id}/portfolioSubstituir a carteiraadmin
POST/api/v1/admin/trade-reps/{id}/portfolio/importImportar carteiraadmin
POST/api/v1/admin/trade-reps/transferTransferir clientesadmin
POST/api/v1/admin/trade-reps/copyCopiar clientesadmin
POST/api/v1/admin/trade-reps/restore-expiredRestaurar vínculos vencidosadmin
GET/api/v1/admin/trade-reps/{id}/vendorsListar sellers atendidosadmin
POST/api/v1/admin/trade-reps/{id}/vendorsAtribuir selleradmin
DELETE/api/v1/admin/trade-reps/{id}/vendors/{vendorId}Remover selleradmin
GET/api/v1/admin/trade-reps/{id}/summaryResumoadmin
GET/api/v1/admin/trade-reps/{id}/dashboardPaineladmin
GET/api/v1/admin/trade-reps/{id}/ordersPedidos do representanteadmin
GET/api/v1/admin/trade-reps/by-stateRepresentantes por estadoadmin
GET/api/v1/admin/trade-reps/{id}/commissionsListar comissõesadmin
POST/api/v1/admin/trade-reps/{id}/commissionsLançar comissãoadmin
PATCH/api/v1/admin/trade-reps/commissions/{commId}/statusMudar status da comissãoadmin

Erros comuns

  • Mandar o id como UUID. O {id} do representante é inteiro; texto devolve 400 invalid trade rep ID.
  • Criar sem senha. Se o e-mail não tem usuário seller ainda, a criação exige password (400 password_required).
  • E-mail de outro tipo de conta. Se o e-mail já pertence a um cliente ou administrador, a criação devolve 409 email_in_use.
  • Transferir sem listar clientes. Se customer_ids vier vazio (ou all_filtered: true), a operação alcança toda a carteira do representante de origem.
  • Esperar 404 ao excluir um id que não existe. DELETE devolve sempre 200 {"status":"deleted"}.
  • Contar com o 409 de cliente já atribuído. Atribuir de novo apenas atualiza o vínculo; não há erro.
  • Esquecer o vendor_id no modo seller. Transferir, copiar e substituir carteira trabalham por vendor_id; vazio significa os vínculos globais, não os do seller.

Próximos passos

Criar um representante
Listar e cadastrar.
Carteira de clientes
Atribuir, remover e consultar.
Campo e alçadas
Rotas de visita, check-ins e descontos.
Anterior
Vitrine própria do seller
Próxima
Listar e criar representantes
Nesta página
  • Como funciona
  • Conceitos-chave
  • Modos: marketplace e seller
  • Carteira e tipos de vínculo
  • Nível hierárquico e alçada
  • Estados e letras
  • Endpoints
  • Erros comuns
  • Próximos passos