Editar cupón

API para modificar la información de cupones generados.

En los cupones ya utilizados, solo se puede actualizar el campo de nota; los demás datos no se pueden modificar.

Esta API está disponible en planes Personal y superiores.

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.
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

codeinteger
Código de respuesta: 0 = Éxito, otros valores = Error
messagestring
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
resultnull