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

Clientes do seller

Como o seller (lojista) enxerga seus clientes, monta a carteira própria, acompanha quem está atrasado na recompra e organiza clientes em grupos.

Numa loja com vários sellers (lojistas), o cliente pertence à loja, mas cada seller precisa saber quem compra dele. Esta seção entrega isso: a lista dos clientes que já pediram ao seller (com total gasto e último pedido), a carteira própria (clientes que o seller cadastra à mão ou importa por CPF/CNPJ, mesmo que ainda não tenham comprado), a frequência de compra esperada para destacar quem está atrasado e os grupos de clientes que o seller pode gerir. Tudo vive em /api/v1/vendor/customers e /api/v1/vendor/usergroups.

Pontos principais
  • O seller só vê clientes que compraram dele ou que ele pôs na carteira própria. A soma de pedidos e valores é sempre só dos pedidos do próprio seller.
  • Valores em centavos na API (total_spent), mas o CSV de exportação traz reais com ponto decimal (43663.31).
  • A carteira liga clientes que já existem na loja; ela nunca cria um usuário. Importar um CPF que ninguém cadastrou volta customer_not_found.
  • Listas vazias de clientes voltam como "customers": null, não []. Trate null como vazio.
  • Os grupos de clientes exigem o módulo vendor-usergroups e só aceitam grupos que o administrador marcou como gerenciáveis pelo seller.

Como funciona

Quem aparece na lista

Cliente compra do seller→Entra na lista com totais→Seller organiza em carteira e grupos

A lista junta duas origens: quem tem pedido com o seller e quem foi posto na carteira (sem precisar de pedido). Um cliente que só está na carteira aparece com order_count zero e days_since_last_order ausente.

Frequência esperada e atraso

O seller define quantos dias costuma esperar entre uma compra e a seguinte (PUT /customers/expected-frequency). Com isso, cada cliente ganha days_overdue: quantos dias passaram além do esperado (0 é "em dia" ou "frequência não configurada"). Quem nunca comprou não entra em "atrasado": ele tem seu próprio filtro, never_ordered.

Carteira própria e importação

Ficar na carteira é um vínculo seller-cliente que existe sozinho: tirar o cliente da carteira não apaga o usuário nem os pedidos, e o cliente continua na carteira de outros sellers.

Conceitos importantes

Identidade PF e PJ

person_type é F (pessoa física, com cpf) ou J (pessoa jurídica, com cnpj, legal_name razão social e trade_name nome fantasia). display_name já escolhe o melhor nome para mostrar: fantasia, depois razão social, depois nome.

Dados pessoais

cpf e cnpj aparecem sem máscara. Trate-os como dado pessoal (LGPD) e não os registre em log.

Endpoints

MétodoCaminhoPara quêAuth
GET/api/v1/vendor/customersLista os clientes do seller, ou o detalhe de um (?id=).seller
GET/api/v1/vendor/customers/statsTotais da base de clientes.seller
GET/api/v1/vendor/customers/exportBaixa a lista em CSV.seller
POST/api/v1/vendor/customers/portfolioPõe clientes na carteira.seller
DELETE/api/v1/vendor/customers/portfolioTira clientes da carteira.seller
POST/api/v1/vendor/customers/importLiga clientes à carteira por CPF/CNPJ, com prévia.seller
PUT/api/v1/vendor/customers/expected-frequencyDefine a frequência de compra esperada.seller
GET/api/v1/vendor/usergroupsGrupos que o seller pode gerir.seller
GET/api/v1/vendor/usergroups/{usergroupId}/membersClientes do seller num grupo.seller
POST/api/v1/vendor/usergroups/{usergroupId}/members/{customerId}Põe um cliente no grupo.seller
DELETE/api/v1/vendor/usergroups/{usergroupId}/members/{customerId}Tira um cliente do grupo.seller

Erros comuns

  • Procurar customers: [] numa lista vazia. Vem null.
  • Enviar um id que não é UUID em GET /customers?id=. Volta 500, não 400.
  • Importar CPF digitado com erro. O dígito verificador é conferido: a linha volta invalid_document e as outras seguem.
  • Esperar que a carteira crie o cliente. Ela só liga; documento sem cadastro volta customer_not_found.
  • Pôr no grupo um cliente que nunca comprou do seller. O servidor recusa (has no orders with vendor).
  • Usar filter=overdue sem ter configurado a frequência. Com frequência 0 ninguém está atrasado e a lista vem vazia.

Próximos passos

Lista e exportação
Ler clientes, detalhe, totais e CSV.
Carteira e frequência
Montar a carteira própria.
Grupos de clientes
Organizar clientes em grupos.
Anterior
Personalização
Próxima
Lista e exportação de clientes
Nesta página
  • Como funciona
  • Quem aparece na lista
  • Frequência esperada e atraso
  • Carteira própria e importação
  • Conceitos importantes
  • Identidade PF e PJ
  • Dados pessoais
  • Endpoints
  • Erros comuns
  • Próximos passos