Saltar al contenido principal
POST
Create coupon

Endpoint

POST /stores/{storeId}/coupons Crea un nuevo cupón para productos y/o categorías.

Autenticación

  • Ruta privada.
  • Requiere header Authorization con su API key y plan activo.

Parámetros de ruta


Body (JSON)

Es necesario enviar al menos uno entre productIds y categoryIds.

Ejemplo de solicitud


Snippet estándar (cURL)

Use el ejemplo cURL de la sección Ejemplo de solicitud anterior como snippet oficial.

Respuesta exitosa (201)


Posibles errores

  • 400 INVALID_DATA -> body inválido
  • 400 INVALID_DATA_CODE -> code ausente o fuera de 3 a 32 caracteres
  • 400 INVALID_DATA_DISCOUNT -> discount ausente o fuera de 1 a 100
  • 400 INVALID_DATA_USE_LIMIT -> useLimit fuera de -1 a 9999
  • 400 INVALID_DATA_RULES -> rules inválido o regla malformada
  • 400 INVALID_DATA_EXPIRED_AT -> expiredAt inválido o no está en el futuro
  • 400 INVALID_DATA_SCOPE_REQUIRED -> no se envió ni productIds ni categoryIds
  • 400 RELATION_NOT_FOUND -> producto/categoría inválido
  • 401 API_KEY_NOT_PROVIDED -> header Authorization no enviado
  • 401 INVALID_API_KEY -> API key inválida
  • 401 UNAUTHENTICATED -> usuario no autenticado
  • 403 USER_DISABLED -> usuario deshabilitado
  • 403 NO_ACTIVE_SUBSCRIPTION -> sin plan activo
  • 403 COUPON_LIMIT_REACHED -> límite de cupones del plan alcanzado
  • 404 STORE_NOT_FOUND -> tienda no encontrada
  • 409 COUPON_ALREADY_EXISTS -> código ya existente
  • 429 RATE_LIMIT_EXCEEDED -> límite de solicitudes por minuto excedido
  • 500 INTERNAL_SERVER_ERROR -> error interno
  • 503 SERVICE_UNAVAILABLE -> servicio no disponible

Autorizaciones

Authorization
string
header
predeterminado:YOUR_API_KEY_HERE
requerido

Parámetros de ruta

storeId
string
requerido
Required string length: 1 - 50

Cuerpo

application/json

Coupon details (code, discount, expiration).

code
string
requerido
Required string length: 3 - 32
discount
integer
requerido
Rango requerido: 1 <= x <= 100
useLimit
integer | null
Rango requerido: -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

Respuesta

Create coupon.

code
string
requerido
Ejemplo:

"COUPON_CREATED"

coupon
object
requerido

Store discount coupon.