Créer un coupon

Cette API permet de créer des coupons de réduction.

Pour générer plusieurs coupons à la fois, utilisez le tableau de bord.

Les images de coupons ne peuvent pas être téléversées via l’API.
Si une image est nécessaire, créez d’abord un groupe de coupons dans le tableau de bord, enregistrez-y l’image, puis assignez ce groupe lors de la création du coupon.

Cette API est disponible avec les forfaits Personal et supérieurs.

POST

/api/coupon/v1/create 

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

Request Parameters

cpnNostring
Numéro du coupon. 8 à 16 caractères alphanumériques. Si aucune valeur n’est saisie, le système le génère automatiquement. Les caractères spéciaux ne sont pas autorisés.
Exemple : V5H8GR5T
nmstringrequired
Nom du coupon.
discTypeIdxintegerrequired
Type de réduction. (457 : Pourcentage %, 458 : Montant fixe)
discdoublerequired
Pourcentage (457) : plage de 1 à 100 %. Montant fixe (458) : saisir la valeur.
discCurrencystring
Devise. Obligatoire lors de l’utilisation d’une réduction à montant fixe (discTypeIdx:458).
strtYmddaterequired
Date de début de validité du coupon. Exemple : 2024-10-01
endYmddaterequired
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.
useLimitintegerrequired
Limite d’utilisation du coupon. (0 : Illimité, 1–5 : Nombre d’utilisations)
Si défini sur 2 ou plus, la valeur userId doit obligatoirement ê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": "ZJLF0399WQBEQZJM"
}

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é.
resultstring
Valeur de réponse. Le numéro de coupon généré est renvoyé.
Exemple : ZJLF0399WQBEQZJM