API de actualización de cupones

La API de actualización de cupones permite modificar los datos de cupones ya emitidos.

Usando el código de cupón (cpNo) como identificador, puede actualizar el tipo de descuento, la fecha de expiración, los límites de uso, el grupo y la información del usuario.
Algunos campos no pueden modificarse una vez que el cupón ha sido canjeado.

Esta API está disponible a partir del plan Personal.

PUT

/api/coupon/v1/update 

{
    "cpnNo": "ZJLF0399WQBEQZJM",
    "nm": "$10 discount coupon",
    "disc": 10,
    "endYmd": "2025-12-31"
}

Request Parameters

cpnNostringrequired
Número de cupón.
domain string
Dominio del cupón.
Disponible en planes Premium y superiores: puede especificar un dominio personalizado.
webhookEnableYn string
Enum:
YN
Activación del Webhook.
El Webhook global debe estar habilitado.
Esta función solo está disponible en el plan Enterprise.
nmstring
Nombre del cupón.
discTypeIdxinteger
Tipo de descuento. (457: Porcentaje %, 458: Descuento fijo)
discdouble
Para porcentaje (457): rango de 1 a 100%. Para descuento fijo (458): ingresar monto.
discCurrencystring
Moneda. Obligatorio al usar descuento fijo (discTypeIdx:458).
strtYmddate
Fecha de inicio de validez del cupón. Ejemplo: 2024-10-01
endYmddate
Fecha de vencimiento del cupón. Ejemplo: 2024-12-31
La fecha de vencimiento solo se puede establecer hasta el 31 de diciembre del año siguiente.
useLimitinteger
Límite de uso del cupón. (0: Ilimitado, 1–5: Número de usos)
Si se establece en 2 o más, el valor userId debe especificarse.
grpIdxinteger
Grupo de cupones. Se utiliza para gestionar cupones por grupos. El IDX del grupo se puede consultar en el panel de control.
Si hay configuraciones duplicadas entre grupo y cupón, prevalece la del grupo.
tmplIdxinteger
Plantilla de cupón. Se utiliza como referencia al crear un cupón. El IDX de la plantilla se puede consultar en el panel.
onsiteYnstring
Indicador de cupón presencial. Muestra el botón “Usar cupón” en la página del cupón.
Necesario para que el personal en tienda valide el cupón.
onsitePwdstring
Contraseña del cupón presencial. Obligatoria al usar el cupón.
memostring
Nota interna de referencia.
urlstring
Si se introduce una URL, se mostrará un botón “Ir a usar cupón” en la página del cupón.
Al hacer clic en el botón o en la imagen se redirige a esa URL.
colorstring
Color del texto del cupón. Ingresar valor HEX. Ejemplo: #4F4F4F
backgroundstring
Color de fondo del cupón. Ingresar valor HEX. Ejemplo: #FFFFFF
userIdstring
Se utiliza para gestionar al destinatario del cupón.
Obligatorio si el límite de uso está entre 2 y 5. Normalmente es el ID de inicio de sesión o nombre del usuario.
userNmstring
Nombre del usuario del cupón. Uso interno.
userPhnnostring
Teléfono del usuario del cupón. Uso interno.
userEmlstring
Correo electrónico del usuario del cupón. Uso interno.
userEtc1string
Campo adicional para gestión interna.
userEtc2string
Campo adicional para gestión interna. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

code integer
Código de respuesta: 0 = Éxito, otros valores = Error
message string
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
result null

Cuándo usar esta API

Utilice esta API cuando necesite modificar las condiciones de cupones ya emitidos.

Es útil para gestionar campañas activas, como extender periodos promocionales, ajustar descuentos o añadir restricciones por usuario.

Dado que el código del cupón no cambia, puede actualizar sus condiciones sin necesidad de volver a emitir ni retirar los cupones ya distribuidos.

Cómo extender la expiración

Para extender la fecha de expiración, establezca un nuevo valor en el parámetro endYmd.
Los cupones expirados pueden reactivarse al actualizar la fecha a un valor futuro. Utilice el formato YYYY-MM-DD.

Casos de uso

  • Extender promociones: Actualice endYmd para ampliar la validez de una campaña activa
  • Ajustar configuraciones de descuento: Modifique disc según cambios en la estrategia
  • Aumentar límites de uso: Incremente useLimit para permitir usos repetidos en clientes VIP
  • Reasignar grupos: Cambie grpIdx para mover el cupón a otro grupo y aplicar nuevas configuraciones
  • Segmentación de usuarios: Ofrezca descuentos personalizados según email o ID de usuario
  • Actualizar landing page: Cambie la URL del cupón a otra página promocional

Aspectos a tener en cuenta

  • Si cpNo (código de cupón) no es válido, la actualización fallará.
  • Algunos campos pueden estar restringidos si el cupón ya ha sido utilizado.
  • Modificar el descuento puede afectar la experiencia del usuario.
  • Los cupones expirados pueden no activarse inmediatamente tras la actualización.
  • En cupones de tienda física, actualice la contraseña cuando cambie el personal.