Developer API

Modifier le coupon

Cette API permet de modifier les informations d’un coupon existant.
Cependant, si le coupon a déjà été utilisé, seul le champ "mémo" peut être modifié ; les autres champs ne peuvent pas être changés.

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

Http Header

PUT /api/coupon/v1/update
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: application/json
User-agent: {Your User-agent}
Accept-Language: en

Request

{
	"cpnNo": "",  // You can specify a coupon code manually. If left empty, a 16-character code will be generated automatically by the system.
	"grpIdx": 271,
	"tmplIdx": 0,
	"nm": "$5 discount coupon",
	"discTypeIdx": 458,
	"disc": 5,
	"strtYmd": "2025-01-01",
	"endYmd": "2025-12-31",
	"onsiteYn": "Y",
	"onsitePwd": "123456",
	"memo": "New Member Registration, IP: 211.111.222.33",
	"url": "https://bestshop.com",
	"useLimit": 1,
	"userId": "att78z",
	"userNm": "Brown Smith",
	"userPhnno": "+1 123-4567-8900",
	"userEml": "",
	"userEtc1": "Gold rating",
	"userEtc2": ""
}

Domaines	Description des champs	Description	Type
cpnNo	Numéro du coupon	Entrez uniquement le numéro du coupon sans le caractère “-”.	string
grpIdx	Groupe de coupons	Le groupe est utilisé pour organiser les coupons. Si les paramètres du groupe et du coupon se chevauchent, ceux du groupe prévalent. Vérifiez l’IDX du groupe sur la page Groupe de coupons du tableau de bord. Valeur par défaut : 0	int
tmplIdx	Modèle de coupon	Utilisé pour afficher la description, l’utilisation et les conditions du coupon à l’utilisateur. Vérifiez l’IDX du modèle sur la page Modèles de coupons du tableau de bord. Valeur par défaut : 0	int
nm	Nom du coupon	Le nom du coupon affiché sur la page du coupon.	string
discTypeIdx	Type de remise	Définit le type de remise : pourcentage ou montant. 457 : Remise en % / 458 : Remise en montant % : Remise basée sur un pourcentage. Montant : Remise fixe en devise.	int
disc	Valeur de la remise	Pour une remise en %, entrez une valeur entre 1% et 100%. Pour une remise en montant, saisissez la valeur exacte à déduire.	double
discCurrency	Devise	Définit la devise si la remise est de type montant (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Valeur par défaut : KRW	string
strtYmd	Date de début	Définissez la date de début de validité du coupon. Format : yyyy-mm-dd (ex. : 2024-10-01)	date
endYmd	Date d’expiration	Définissez la date de fin de validité du coupon. Format : yyyy-mm-dd (ex. : 2024-12-31)	date
onsiteYn	Coupon en magasin	Si la valeur est Y, un bouton “Utiliser” s’affichera sur la page du coupon. Conçu pour une utilisation par le personnel du magasin lorsque le client présente le coupon.	Y ou N
onsitePwd	Mot de passe de validation	Si un mot de passe est défini, le personnel doit le saisir pour valider le coupon. Empêche l’utilisation non autorisée par l’utilisateur.	string
memo	Note	Utilisé à des fins de gestion interne uniquement. Non visible par les utilisateurs.	string
url	URL	Affiche un bouton “Utiliser le coupon” redirigeant vers cette URL. Si une image est jointe, cliquer dessus redirige également.	string
useLimit	Limite d’utilisation par personne	Définit combien de fois une personne peut utiliser le coupon. Pour 2 à 5 utilisations, l’API REST nécessite la saisie de l’ID utilisateur. Pour une gestion manuelle, seules les options “illimité” ou “1 fois” sont possibles. 0 : illimité, 1 : 1 fois, ... jusqu’à 5 fois.	int
color	Couleur du texte	Définit la couleur du texte du coupon en HEX (jusqu’à 9 caractères, transparence incluse). Valeur par défaut : #4F4F4FFF	string
background	Couleur de fond	Définit la couleur de fond du coupon en HEX (jusqu’à 9 caractères). Valeur par défaut : #FFFFFFFF	string
userId	ID utilisateur	Utilisé pour suivre qui a reçu ou utilisé le coupon. Obligatoire si la limite est fixée entre 2 et 5 fois. Utilisez généralement l’ID de connexion du site.	string
userNm	Nom de l’utilisateur	Si vous connaissez déjà l’utilisateur, saisissez son nom ici pour une gestion plus facile.	string
userPhnno	Numéro de téléphone	Numéro de téléphone de l’utilisateur pour utiliser le coupon.	string
userEml	Email de l’utilisateur	Email de l’utilisateur pour utiliser le coupon.	string
userEtc1	Autres infos utilisateur 1	Informations complémentaires à usage interne.	string
userEtc2	Autres infos utilisateur 2	Informations complémentaires à usage interne.	string

Response

{
	"code": 0,
	"message": "",
	"result": "ZJLF0399WQBEQZJM"
}

Domaines	Description	Type
code	Code de réponse (0:Succès)	int
message	Le message de réponse, ou un message connexe si le code de réponse est différent de zéro.	string