Créer un coupon
Cette API permet de créer des coupons de réduction.
Pour créer plusieurs coupons à la fois, vous devez utiliser le tableau de bord.
L’API ne permet pas de téléverser des images de coupons.
Si vous avez besoin d’images, créez d’abord un groupe de coupons dans le tableau de bord et téléversez-y l’image, puis spécifiez ce groupe lors de la création du coupon.
Si un groupe de coupons est spécifié, certains paramètres du coupon seront ignorés et ceux du groupe seront appliqués en priorité.
Cette API est disponible à partir de l’offre Personal.
Http Header
POST /api/coupon/v1/create
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 | Exigée | Type |
|---|---|---|---|---|
| cpnNo | Un numéro de coupon de 8 à 16 chiffres composé de lettres majuscules et de chiffres. Les caractères spéciaux ne sont pas autorisés. Si ce champ est vide, le numéro du coupon est généré automatiquement par le système. | string | ||
| grpIdx | Les groupes de coupons servent à organiser les coupons par catégorie. En cas de conflit, le paramètre du coupon prévaut. Voir l’IDX de groupe sur la page des groupes de coupons du tableau de bord. Valeur par défaut : 0 | int | ||
| tmplIdx | Les modèles de coupons précisent l’usage, l’utilisation et les conditions du coupon. L’IDX du modèle se trouve sur la page des modèles de coupons dans le tableau de bord. Valeur par défaut : 0 | int | ||
| nm | Le nom du coupon apparaît sur la page du coupon. | string | ||
| discTypeIdx | Définir le type de réduction (taux ou montant) du coupon. 457 : Réduction en pourcentage (%), 458 : Réduction en montant. Réduction en pourcentage : applique un pourcentage. Réduction en montant : applique un montant fixe. | int | ||
| disc | Saisir une valeur entre 1 % et 100 % pour un taux (457). Entrer le montant pour une réduction en valeur (458). | double | ||
| discCurrency | Possibilité de définir la devise pour les réductions en montant (458). KRW, CAD, CNY, EUR, GBP, IDR, JPY, MUR, RUB, SGD, USD Valeur par défaut : KRW | string | ||
| strtYmd | Définir la date de début de validité du coupon. Valeur à 10 chiffres, format aaaa-mm-jj. Exemple : 2024-10-01 | date | ||
| endYmd | Définir la date de fin de validité du coupon. Valeur à 10 chiffres, format aaaa-mm-jj. Exemple : 2024-12-31 | date | ||
| onsiteYn | Si la valeur est Y, la page du coupon affiche un bouton pour valider le coupon en magasin. L’utilisateur présente le coupon à un employé, qui valide le coupon. Utile pour les boutiques physiques. Valeur par défaut : N | Y or N | ||
| onsitePwd | En cas de mot de passe, le personnel du magasin doit le saisir pour valider le coupon. L’utilisateur ne peut pas valider le coupon lui-même. | string | ||
| memo | Utilisé à des fins internes pour gérer les coupons. Non visible pour les utilisateurs. | string | ||
| url | Si une URL est renseignée, la page du coupon affiche un bouton « Utiliser le coupon » qui dirige vers cette URL. Si une image de coupon est ajoutée, cliquer sur l’image ouvre également l’URL. | string | ||
| useLimit | Définir le nombre maximum d’utilisations par personne. Si la limite par personne est comprise entre 2 et 5 (API REST Vivoldi), l’ID utilisateur est obligatoire. Depuis le tableau de bord, vous pouvez choisir « Illimité » ou « 1 fois ». Si vous choisissez « Illimité », le coupon peut être utilisé un nombre illimité de fois. 0 : Illimité, 1 : 1 fois, 2 : 2 fois, 3 : 3 fois, 4 : 4 fois, 5 : 5 fois | int | ||
| color | Définir la couleur du texte du coupon sur la page. À saisir en format HEX, jusqu’à 9 caractères, incluant la transparence. Valeur par défaut : #4F4F4FFF | string | ||
| background | Définir la couleur d’arrière-plan du coupon sur la page. À saisir en format HEX, jusqu’à 9 caractères, incluant la transparence. Valeur par défaut : #FFFFFFFF | string | ||
| userId | Permet de savoir qui a émis ou utilisé le coupon. Si la limite d’utilisations par personne est entre 2 et 5, l’ID utilisateur est obligatoire. En général, il s’agit de l’identifiant de connexion de l’utilisateur. | string | ||
| userNm | Si vous connaissez déjà l’utilisateur, renseignez son nom ici. Utile pour gérer l’émission et l’utilisation du coupon. | string | ||
| userPhnno | Saisir le contact de l’utilisateur qui utilisera le coupon. | string | ||
| userEml | Saisir l’adresse e-mail de l’utilisateur qui utilisera le coupon. | string | ||
| userEtc1 | Saisir des informations supplémentaires sur l’utilisateur à des fins administratives. | string | ||
| userEtc2 | Saisir des informations supplémentaires sur l’utilisateur à des fins administratives. | 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 |
| result | Valeur de la réponse (numéro de coupon) | string |