Afiliados
Criar Afiliado
Aprenda a criar um afiliado usando o endpoint POST /stores//affiliates.
POST
Create affiliate
📌 Endpoint
POST /stores/{storeId}/affiliates
Cria um novo afiliado na loja.
O code (slug) é usado para montar o link de divulgação:
https://SEU_DOMINIO.com.br/l/{code}.
🔐 Autenticação
- Rota privada.
- Requer header
Authorizationcom sua API key e plano ativo.
🧾 Parâmetros de rota
📤 Body (JSON)
✅ Exemplo de requisição
📦 Resposta de sucesso (201)
⚠️ Possíveis erros
400 INVALID_DATA→ body inválido400 INVALID_DATA_NAME→nameausente ou fora de 1 a 56 caracteres400 INVALID_DATA_EMAIL→emailausente, inválido ou maior que 120 caracteres400 INVALID_DATA_CODE→codeausente, fora de 3 a 50 caracteres ou fora do padrão slug400 INVALID_DATA_IMAGE→imageinválida (URLhttp/httpsinválida ou maior que 512 caracteres)400 INVALID_DATA_METADATA→metadatainválido (não é objeto ou excede 64 chaves)400 INVALID_DATA_RULES→commissionRulesinválido (não é um array)400 INVALID_COMMISSION_RULES→commissionRulesvazio400 INVALID_COMMISSION_RULE_TYPE→typeinválido400 INVALID_COMMISSION_RULE_POSITION→positioninválida/duplicada400 INVALID_COMMISSION_VALUE→commissionfora de 1 a 100400 COMMISSION_RULE_DEFAULT_REQUIRED→ falta exatamente uma regraDEFAULT400 INVALID_COMMISSION_RULE_TARGET→DEFAULTcomtargetId, ouPRODUCT/CATEGORY/COUPONsemtargetId400 RELATION_NOT_FOUND→targetIdde produto/categoria/cupom inexistente na loja401 API_KEY_NOT_PROVIDED→ headerAuthorizationnão enviado401 INVALID_API_KEY→ API key inválida401 UNAUTHENTICATED→ usuário não autenticado403 USER_DISABLED→ usuário desativado403 NO_ACTIVE_SUBSCRIPTION→ sem plano ativo404 STORE_NOT_FOUND→ loja não encontrada409 AFFILIATE_ALREADY_EXISTS→codejá existente409 AFFILIATE_EMAIL_ALREADY_EXISTS→ e-mail já cadastrado por outro afiliado na loja429 RATE_LIMIT_EXCEEDED→ limite de requisições por minuto excedido500 INTERNAL_SERVER_ERROR→ erro interno503 SERVICE_UNAVAILABLE→ serviço indisponível
Corpo
application/json
Affiliate details (name, email, code, commissionRules).