Pular para o conteúdo principal
GET
Get coupon by code

📌 Endpoint

GET /stores/{storeId}/coupons/{code} Busca um cupom pelo código para uso em checkout.

🔐 Autenticação

  • Rota pública.
  • A loja precisa estar com plano ativo.

🧾 Parâmetros de rota


🔎 Query params


✅ Exemplo de requisição


📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → parâmetros inválidos
  • 400 COUPON_EXPIRED → cupom expirado
  • 400 COUPON_ALREADY_USED → limite de uso atingido ou cliente (email/cpf) já utilizou o cupom com SINGLE_USE_PER_CUSTOMER
  • 401 UNAUTHENTICATED → não autenticado
  • 403 NO_ACTIVE_SUBSCRIPTION → plano inativo/expirado
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 COUPON_NOT_FOUND → cupom inexistente
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto excedido
  • 500 INTERNAL_SERVER_ERROR → erro interno do servidor
  • 503 SERVICE_UNAVAILABLE → serviço indisponível

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50
code
string
obrigatório
Required string length: 1 - 32

Parâmetros de consulta

email
string<email>

Optional buyer email to validate single-use-per-customer coupons.

cpf
string

Optional buyer CPF to validate single-use-per-customer coupons.

Resposta

Get coupon by code.

code
string
obrigatório
Exemplo:

"SUCCESS"

coupon
object
obrigatório

Store discount coupon.