Cadastro de sellers
Como um seller (lojista) entra no marketplace, da candidatura aos termos de uso e à vitrine própria, com o mapa das rotas do administrador.
Em um marketplace, seller (lojista) é a empresa que vende produtos dentro da loja. Antes de vender, ela passa por uma análise de entrada (onboarding): envia uma candidatura, anexa documentos que provam quem é, aceita os termos de uso e, aprovada, ganha acesso ao painel. Opcionalmente ela monta uma vitrine própria (um "microsite") com logo, cores e domínio.
Esta seção reúne o lado do administrador desse processo. As rotas do próprio seller (enviar a candidatura, subir documentos, aceitar termos) ficam na API do painel do seller.
Como funciona
O caminho do seller
- O seller se candidata
Pelo painel dele, o seller envia a candidatura. Ela nasce
pending. - O seller anexa documentos
O seller pode anexar documentos à própria candidatura (a primeira anexação leva a candidatura para
under_review) e também enviar documentos avulsos de verificação (KYC). Cada documento nasce pendente. Veja a diferença em Conceitos importantes. - Você analisa
Liste as candidaturas e os documentos de verificação, abra os arquivos e aprove ou recuse cada documento. Depois decida a candidatura.
- O seller aceita os termos
O seller aceita a versão ativa dos termos de uso. Cada nova versão ativada pede novo aceite.
Estados da candidatura
status | Significado |
|---|---|
pending | Enviada, sem documentos. |
under_review | Tem documentos e aguarda decisão. |
approved | Aprovada: o seller foi ativado. |
rejected | Recusada: o seller foi marcado como recusado e há rejection_reason. |
Estados do documento
| Letra | Significado |
|---|---|
P | Pendente de análise. |
A | Aprovado. |
R | Recusado. |
E | Vencido. |
O | Pendente (valor antigo, tratado como P). |
Tipos de documento aceitos
business_license, identity, tax_registration, proof_of_address, bank_statement, other, cnpj, address, bank, id_card, cpf_cnpj, company_registration, bank_info, address_proof, tax_certificate.
Conceitos importantes
Quem decide o quê
Estas rotas são do administrador. A análise de candidatura exige manage_vendor_moderation ou manage_catalog (ler também aceita view_catalog). A de documentos exige manage_documents, manage_kyc ou manage_vendors para decidir. Termos exigem manage_vendor_terms ou manage_vendors. Vitrines exigem manage_vendor_storefronts ou manage_vendors.
Dois tipos de documento
- Documentos de verificação (KYC): enviados pelo seller de forma avulsa, ligados ao seller. São os que a lista
GET /vendor-documentsmostra e que as rotas de revisão desta seção tratam. - Documentos da candidatura: anexados pelo seller à própria candidatura. Ficam ligados à candidatura, não aparecem em
GET /vendor-documentse são vistos no detalhe da candidatura do seller.
Se um seller diz que "enviou o documento" e ele não está na lista, confira por qual caminho ele foi enviado.
Aprovação de documentos em lote
Quando há muitos comprovantes, a revisão em lote decide vários de uma vez. Ela só altera documentos pendentes: ids já aprovados ou recusados são ignorados sem erro, e a resposta informa quantos foram de fato revisados.
Endpoints
| Método e caminho | Para que serve | Auth | Página |
|---|---|---|---|
GET /api/v1/admin/vendor-applications | Lista as candidaturas | admin | Candidaturas |
PUT /api/v1/admin/vendor-applications/{id}/review | Aprova ou recusa a candidatura | admin | Candidaturas |
GET /api/v1/admin/vendor-documents | Lista os documentos | admin | Documentos |
GET /api/v1/admin/vendor-documents/{id} | Detalha um documento | admin | Documentos |
GET /api/v1/admin/vendor-documents/{id}/download | Baixa o arquivo | admin | Documentos |
PUT /api/v1/admin/vendor-documents/{id}/review | Aprova ou recusa um documento | admin | Documentos |
POST /api/v1/admin/vendor-documents/bulk-review | Decide vários documentos | admin | Documentos |
GET /api/v1/admin/vendor-terms | Lista as versões dos termos | admin | Termos de uso |
POST /api/v1/admin/vendor-terms | Cria e ativa uma versão | admin | Termos de uso |
GET /api/v1/admin/vendor-terms/{id} | Detalha uma versão | admin | Termos de uso |
PUT /api/v1/admin/vendor-terms/{id} | Edita título e texto | admin | Termos de uso |
POST /api/v1/admin/vendor-terms/{id}/activate | Torna uma versão a ativa | admin | Termos de uso |
DELETE /api/v1/admin/vendor-terms/{id} | Exclui uma versão inativa | admin | Termos de uso |
GET /api/v1/admin/vendor-storefronts | Lista as vitrines dos sellers | admin | Vitrines |
Erros comuns
- Achar que aprovar os documentos aprova o seller. São decisões separadas; decida também a candidatura.
- Decidir a candidatura sem ver os documentos. A lista de candidaturas não traz os documentos; consulte os de verificação na lista de documentos filtrando por
vendor_id. - Aprovar em lote documentos já decididos. São ignorados; confira o campo
reviewedda resposta. - Editar um texto de termos já aceito.
PUTaltera a versão no lugar, sem gerar versão nova nem pedir novo aceite. Para exigir novo aceite, crie uma versão. - Ativar um id errado de termos. A ativação desativa a versão corrente antes de procurar a nova; com um id inexistente, a loja pode ficar sem termos ativos.
- Tentar excluir a versão ativa. É recusado. Ative outra antes.
- Esperar
404em id mal formado. Muitas destas rotas respondem500quando o id não é um UUID.