Parceiros, clientes B2B e representantes
O vocabulário B2B da plataforma 1.0 e o mapa das rotas de parceiros de negócio, carga de clientes e representantes.
Lojas que vendem para empresas (B2B) trabalham com três figuras que a plataforma 1.0 já tinha e que esta API mantém:
- Parceiro de negócio (
business_partner): uma empresa ou pessoa que pede cadastro para comprar (distribuidor, revendedor). Identifica-se por CPF ou CNPJ e passa por uma validação antes de comprar. - Cliente B2B: o usuário comprador, identificado pelo CNPJ da empresa. Um ERP costuma atualizar em lote a situação, os grupos de preço e as formas de pagamento permitidas de cada cliente.
- Representante comercial (rep): o vendedor interno ou externo que atende uma carteira de clientes, às vezes limitada a alguns sellers.
Como funciona
- Validar o documento
Antes de abrir um cadastro, confira o CPF/CNPJ com Parceiros de negócio (
scope: verify_document). - Aprovar e configurar o cliente
Depois que o cliente existe na loja, o ERP envia Carga de clientes por CNPJ: ativa o usuário, coloca-o nos grupos certos e define as formas de pagamento que ele pode usar.
- Escopo do representante
O app do representante lê Representantes comerciais para saber de quais sellers e de quantos clientes ele cuida.
Conceitos importantes
Ids e o caminho sem versão
Estas rotas existem em /api/v1.0/... e em /api/.... O CNPJ e o código do representante são os identificadores de negócio e não mudam de uma forma para a outra. O {id} de parceiro de negócio é um número inteiro.
Grupos de usuários e formas de pagamento por cliente
Um grupo de usuários agrupa clientes para regras de preço e visibilidade (por exemplo "Atacado"). A forma de pagamento por cliente restringe quais meios (boleto, PIX, faturado) aparecem no checkout dele. Lista vazia significa "sem restrição".
Endpoints
| Método | Caminho | Para que serve | Autenticação |
|---|---|---|---|
| GET | /api/v1.0/business_partners | Parceiros de negócio: lista (vazia) | Administrador |
| GET | /api/v1.0/business_partners/{id} | Consulta (esboço) | Administrador |
| POST | /api/v1.0/business_partners | Verifica documento; demais escopos são esboços | Administrador |
| PUT | /api/v1.0/business_partners/{id} | Altera ou valida (esboço) | Administrador |
| POST | /api/v1.0/customer | Carga de clientes por CNPJ | Administrador |
| GET | /api/v1.0/representatives/visibility | Visibilidade do representante | Representante ou administrador |
| PUT | /api/v1.0/representatives/{cod}/usergroup | Define o grupo padrão do representante | Administrador |
Cada linha vale também sem /v1.0 (/api/business_partners..., /api/customer, /api/representatives...).
Erros comuns
- Tratar
201dePOST /business_partnerscomo cadastro feito. Fora da verificação de documento, nada é gravado (id: 0). - Mandar o CNPJ com outra chave. A carga lê a chave
CNPJem maiúsculas. - Esquecer que
paymentssubstitui. Quem mandapaymentsredefine a lista inteira de formas de pagamento do cliente. - Ignorar o
207. Ele indica sucesso parcial: leiaskipped. - Chamar a visibilidade como administrador sem
rep_id. O administrador não é um representante e recebe 404.