Validación de cupones

Esta API se utiliza para comprobar si un cupón es válido antes de procesar su uso.

La validez del cupón se verifica según los siguientes criterios:

  • Validez del número de cupón
  • Período de validez del cupón
  • Si se ha superado el límite de uso
  • Si el cupón ya ha sido utilizado

Esta API está disponible en planes Personal y superiores.

GET

/api/coupon/v1/validate?cpnNo={cpnNo}

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
Número de cupón. 
{
    "code": 0,
    "message": "",
    "result": {
        "cpnNo": "ZJLF0399WQBEQZJM",
        "nm": "$100 off cake coupon",
        "discTypeIdx": 457,
        "discCurrency": "USD",
        "formatDiscCurrency": "$60",
        "disc": 60.0,
        "strtYmd": "2025-01-01",
        "endYmd": "2025-12-31",
        "useLimit": 1,
        "imgUrl": "https://file.vivoldi.com/coupon/2024/11/08/lmTFkqLQdCzeBuPdONKG.webp",
        "onsiteYn": "Y",
        "onsitePwd": "123456",
        "memo": "60% off cake with coupon at the venue",
        "url": "",
        "userId": "user08",
        "userNm": "Emily",
        "userPhnno": "202-555-0173",
        "userEml": "test@gmail.com",
        "userEtc1": "",
        "userEtc2": "",
        "useCnt": 0,
        "regYmdt": "2024-11-17 17:29:25"
    }
}

Response Parameters

codeinteger
Código de respuesta: 0 = Éxito, cualquier otro valor = Error
messagestring
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje relacionado con el error.
resultobject
Validación exitosa: La respuesta devuelve la información del cupón.
Validación fallida: La respuesta es null y se puede verificar mediante el mensaje de error.
cpnNostring
Número de cupón.
nmstring
Nombre del cupón.
discTypeIdxinteger
Tipo de descuento. (457: porcentaje %, 458: descuento en importe)
discdouble
Para porcentaje (457): rango 1–100%. Para importe (458): introducir el valor monetario.
discCurrencystring
Moneda. Obligatorio al usar descuento por importe (discTypeIdx:458).
formatDiscCurrencystring
Símbolo de moneda.
strtYmddate
Fecha de inicio de validez del cupón.
endYmddate
Fecha de expiración del cupón.
useLimitinteger
Límite de uso del cupón. (0: ilimitado, 1–5: número máximo de usos)
imgUrlstring
URL de la imagen del cupón.
onsiteYnstring
Cupón en tienda. Indica si se muestra el botón «Usar cupón» en la página del cupón.
Necesario cuando el cupón se valida en tiendas físicas.
onsitePwdstring
Contraseña del cupón en tienda. Requerida para validar el cupón en uso.
memostring
Nota de referencia interna.
urlstring
Al introducir una URL, se muestra el botón «Ir a usar el cupón» en la página del cupón.
Al hacer clic en el botón o en la imagen del cupón, se redirige a dicha URL.
userIdstring
Se utiliza para gestionar el destinatario del cupón.
Obligatorio si el límite de uso está configurado entre 2 y 5.
Normalmente se introduce el ID de inicio de sesión del sitio web o el nombre en inglés.
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 de gestión interna.
userEtc2string
Campo adicional de gestión interna.
useCntinteger
Número de usos del cupón.
regYmdtdatetime
Fecha de creación del cupón. Ejemplo: 2025-07-21 11:50:20