Validation du coupon

Cette API est utilisée pour vérifier si un coupon est valide avant son utilisation.

La validité du coupon est vérifiée selon les critères suivants :

  • Validité du numéro de coupon
  • Période de validité du coupon
  • Dépassement du nombre d’utilisations autorisées
  • Si le coupon a déjà été utilisé

Cette API est disponible à partir de l’offre Personal.

GET

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

{
    "cpnNo": "ZJLF0399WQBEQZJM"
}

Request Parameters

cpnNostringrequired
Numéro du coupon. 
{
    "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
Code de réponse : 0 = Succès, toute autre valeur = Erreur
messagestring
Message de réponse. Si le code n’est pas 0, un message d’erreur correspondant est renvoyé.
resultobject
Validation réussie : La réponse renvoie les informations du coupon.
Échec de la validation : La réponse est null et peut être vérifiée via le message d’erreur.
cpnNostring
Numéro du coupon.
nmstring
Nom du coupon.
discTypeIdxinteger
Type de réduction. (457 : remise en %, 458 : remise en montant)
discdouble
Pour les remises en % (457) : plage de 1 à 100 %. Pour les remises en montant (458) : saisissez une valeur.
discCurrencystring
Devise. Obligatoire lors de l’utilisation d’une remise en montant (discTypeIdx :458).
formatDiscCurrencystring
Symbole monétaire.
strtYmddate
Date de début de validité du coupon.
endYmddate
Date d’expiration du coupon.
useLimitinteger
Nombre d’utilisations autorisées. (0 : illimité, 1–5 : utilisation limitée)
imgUrlstring
URL de l’image du coupon.
onsiteYnstring
Coupon sur site. Définit si le bouton « Utiliser le coupon » s’affiche sur la page du coupon.
Requis pour une utilisation en magasin physique.
onsitePwdstring
Mot de passe du coupon sur site. Nécessaire lors de l’utilisation du coupon.
memostring
Note interne.
urlstring
Si une URL est saisie, un bouton « Aller utiliser le coupon » apparaît sur la page du coupon.
Un clic sur le bouton ou l’image du coupon redirige vers cette URL.
userIdstring
Utilisé pour gérer le destinataire du coupon.
Obligatoire si le nombre d’utilisations est défini entre 2 et 5.
En général, il s’agit de l’ID de connexion ou du nom en anglais de l’utilisateur du site.
userNmstring
Nom de l’utilisateur du coupon. Pour usage interne uniquement.
userPhnnostring
Numéro de téléphone de l’utilisateur du coupon. Pour usage interne uniquement.
userEmlstring
E-mail de l’utilisateur du coupon. Pour usage interne uniquement.
userEtc1string
Champ interne supplémentaire.
userEtc2string
Champ interne supplémentaire.
useCntinteger
Nombre d’utilisations du coupon.
regYmdtdatetime
Date de création du coupon. Exemple : 2025-07-21 11:50:20