Pular para o conteúdo principal
POST
Create coupon

Endpoint

POST /stores/{storeId}/coupons Cria um novo cupom para produtos e/ou categorias.

Autenticação

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

Parâmetros de rota


Body (JSON)

É necessário enviar ao menos um entre productIds e categoryIds.

Exemplo de requisição


Snippet padrão (cURL)

Use o exemplo cURL da seção Exemplo de requisição acima como snippet oficial.

Resposta de sucesso (201)


Possíveis erros

  • 400 INVALID_DATA -> body inválido
  • 400 INVALID_DATA_CODE -> code ausente ou fora de 3 a 32 caracteres
  • 400 INVALID_DATA_DISCOUNT -> discount ausente ou fora de 1 a 100
  • 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 INVALID_DATA_SCOPE_REQUIRED -> nenhum entre productIds e categoryIds foi enviado
  • 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
  • 403 COUPON_LIMIT_REACHED -> limite de cupons do plano atingido
  • 404 STORE_NOT_FOUND -> loja não encontrada
  • 409 COUPON_ALREADY_EXISTS -> código já existente
  • 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

Corpo

application/json

Coupon details (code, discount, expiration).

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

Resposta

Create coupon.

code
string
obrigatório
Exemplo:

"COUPON_CREATED"

coupon
object
obrigatório

Store discount coupon.