Modifier le coupon

API permettant de modifier les informations des coupons générés.

Pour les coupons déjà utilisés, seul le champ mémo peut être modifié ; les autres informations ne peuvent pas être changées.

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

PUT

/api/coupon/v1/update 

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

Request Parameters

cpnNostringrequired
Numéro du coupon.
nmstring
Nom du coupon.
discTypeIdxinteger
Type de remise. (457 : Pourcentage %, 458 : Montant fixe)
discdouble
Pour un pourcentage (457) : plage de 1 à 100 %. Pour un montant fixe (458) : saisir la valeur.
discCurrencystring
Unité monétaire. Obligatoire lors de l’utilisation d’une remise en montant fixe (discTypeIdx:458).
strtYmddate
Date de début de validité du coupon. Exemple : 2024-10-01
endYmddate
Date d’expiration du coupon. Exemple : 2024-12-31
La date d’expiration ne peut être définie que jusqu’au 31 décembre de l’année suivante.
useLimitinteger
Limite d’utilisation du coupon. (0 : Illimité, 1–5 : Utilisation limitée)
Si elle est fixée à 2 ou plus, la valeur userId doit être spécifiée.
grpIdxinteger
Groupe de coupons. Utilisé pour gérer les coupons par groupe. L’IDX du groupe peut être vérifié dans le tableau de bord.
En cas de conflit entre les paramètres du groupe et ceux du coupon, les paramètres du groupe sont prioritaires.
tmplIdxinteger
Modèle de coupon. Utilisé comme référence lors de la création d’un coupon. L’IDX du modèle peut être vérifié dans le tableau de bord.
onsiteYnstring
Coupon sur site. Affiche le bouton « Utiliser le coupon » sur la page du coupon.
Nécessaire pour que le personnel en magasin puisse valider le coupon.
onsitePwdstring
Mot de passe du coupon sur site. Requis lors de l’utilisation du coupon.
memostring
Note interne à usage de référence.
urlstring
Si une URL est saisie, un bouton « Aller utiliser le coupon » s’affiche sur la page du coupon.
En cliquant sur le bouton ou sur l’image du coupon, l’utilisateur est redirigé vers cette URL.
colorstring
Couleur du texte du coupon. Entrer une valeur HEX. Exemple : #4F4F4F
backgroundstring
Couleur d’arrière-plan du coupon. Entrer une valeur HEX. Exemple : #FFFFFF
userIdstring
Utilisé pour gérer le bénéficiaire du coupon.
Obligatoire si la limite d’utilisation est fixée entre 2 et 5. Généralement l’ID de connexion ou le nom de l’utilisateur.
userNmstring
Nom de l’utilisateur du coupon. À usage interne.
userPhnnostring
Numéro de téléphone de l’utilisateur du coupon. À usage interne.
userEmlstring
Adresse e-mail de l’utilisateur du coupon. À usage interne.
userEtc1string
Champ supplémentaire pour gestion interne.
userEtc2string
Champ supplémentaire pour gestion interne. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

codeinteger
Code de réponse : 0 = Succès, autres valeurs = Erreur
messagestring
Message de réponse. Si le code n’est pas 0, un message d’erreur est renvoyé.
resultnull