Pular para o conteúdo principal
PUT
Update coupon

📌 Endpoint

PUT /stores/{storeId}/coupons/{couponId} Atualiza parcialmente um cupom existente.

🔐 Autenticação

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

🧾 Parâmetros de rota


🧍 Body (JSON)

Envie pelo menos um campo:
  • code (3-32)
  • discount (1-100)
  • position (inteiro maior ou igual a 1)
  • useLimit (inteiro -1 a 9999; enviar null redefine para -1)
  • rules (array de regras de uso, ex.: [{"type": "SINGLE_USE_PER_CUSTOMER"}]; enviar null ou [] limpa as regras)
  • expiredAt (data futura em formato RFC3339 / date-time, ou null)
  • productIds (array de IDs; enviar null limpa as associações)
  • categoryIds (array de IDs; enviar null limpa as associações)

✅ Exemplo de requisição


Snippet padrao (cURL)

Use o exemplo cURL da secao Exemplo de requisicao acima como snippet oficial.

📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → body inválido
  • 400 INVALID_DATA_CODE → code fora de 3 a 32 caracteres
  • 400 INVALID_DATA_DISCOUNT → discount fora de 1 a 100
  • 400 INVALID_DATA_POSITION → position menor que 1
  • 400 INVALID_DATA_USE_LIMIT → useLimit fora de -1 a 9999
  • 400 INVALID_DATA_RULES → rules inválido ou regra malformada
  • 400 INVALID_DATA_EXPIRED_AT → expiredAt inválido ou não está no futuro
  • 400 RELATION_NOT_FOUND → produto/categoria inválido
  • 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 COUPON_NOT_FOUND → cupom não encontrado
  • 409 COUPON_ALREADY_EXISTS → código duplicado
  • 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
couponId
string
obrigatório
Required string length: 1 - 50

Corpo

application/json

Coupon fields to update.

code
string
Required string length: 3 - 32
discount
integer
Intervalo obrigatório: 1 <= x <= 100
position
integer
Intervalo obrigatório: x >= 1
useLimit
integer | null
Intervalo obrigatório: -1 <= x <= 9999
rules
object[] | null
Maximum array length: 32
expiredAt
string<date-time> | null
productIds
string[] | null
Required string length: 1 - 50
categoryIds
string[] | null
Required string length: 1 - 50

Resposta

Update coupon.

code
string
obrigatório
Exemplo:

"COUPON_UPDATED"

coupon
object
obrigatório

Store discount coupon.