Pular para o conteúdo principal
DELETE
Delete affiliate

📌 Endpoint

DELETE /stores/{storeId}/affiliates/{affiliateId} Remove um afiliado da loja (soft delete). O afiliado some das listagens, mas o registro permanece no banco por segurança — inclusive a resolução de comissões deixa de considerá-lo.
Requisito: O afiliado precisa estar pausado (status: "inativo") há pelo menos 7 dias para poder ser deletado. Caso contrário, a API retorna 400 (AFFILIATE_NOT_PAUSED ou AFFILIATE_PAUSE_PERIOD_NOT_ELAPSED).

🔐 Autenticação

  • Rota privada.
  • Requer header Authorization com sua API key e plano ativo.

🧾 Parâmetros de rota


✅ Exemplo de requisição


📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → parâmetros inválidos
  • 400 AFFILIATE_NOT_PAUSED → o afiliado precisa estar pausado (status: "inativo") antes de ser excluído
  • 400 AFFILIATE_PAUSE_PERIOD_NOT_ELAPSED → o afiliado precisa estar pausado há pelo menos 7 dias
  • 401 API_KEY_NOT_PROVIDED → header Authorization não enviado
  • 401 INVALID_API_KEY → API key inválida
  • 401 UNAUTHENTICATED → usuário não autenticado
  • 403 USER_DISABLED → usuário desativado
  • 403 NO_ACTIVE_SUBSCRIPTION → sem plano ativo
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 AFFILIATE_NOT_FOUND → afiliado não encontrado
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno
  • 503 SERVICE_UNAVAILABLE → serviço indisponível

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50
affiliateId
string
obrigatório
Required string length: 1 - 50

Resposta

Delete affiliate.

code
string
obrigatório
Exemplo:

"AFFILIATE_DELETED"