API de suppression des coupons

L’API de suppression des coupons Vivoldi permet de supprimer définitivement des coupons déjà émis.

Une fois supprimé, le coupon devient immédiatement invalide et toute tentative d’utilisation est bloquée.
Pour supprimer plusieurs coupons en une seule fois, utilisez le tableau de bord.

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

DELETE

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


DELETE /api/coupon/v1/delete
        ?cpnNo=ZJLF0399WQBEQZJM

Request Parameters

cpnNostringrequired
Numéro du coupon. 
{
    "code": 0,
    "message": "",
    "result": null
}

Response Parameters

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

Quand utiliser cette API

Utilisez cette API dans les cas suivants :

  • Bloquer immédiatement des coupons émis par erreur
  • Nettoyer les coupons après la fin d’une campagne
  • Supprimer des coupons en double ou de test
  • Désactiver des coupons susceptibles d’être abusés

En production, elle est principalement utilisée pour le contrôle des risques plutôt que pour un simple nettoyage.

Différence entre suppression et expiration

Il existe deux méthodes pour empêcher l’utilisation d’un coupon.

Si endYmd (date d’expiration) est défini dans le passé, le coupon expire mais les données sont conservées et peuvent être réactivées ultérieurement.
En revanche, l’appel de l’API de suppression supprime définitivement les données du coupon et empêche toute récupération.

Pour une désactivation temporaire, il est recommandé d’ajuster la date d’expiration via l’API de mise à jour plutôt que de supprimer le coupon.

Cas d’utilisation

  • Nettoyage après campagne : Supprimez les coupons inutiles après la fin d’un événement
  • Suppression de coupons invalides : Supprimez immédiatement les coupons créés par erreur, pour test ou avec une mauvaise configuration
  • Blocage de coupons divulgués : En cas de fuite, utilisez l’API pour empêcher leur utilisation immédiatement

Après suppression, le même code peut être réutilisé pour créer un nouveau coupon.

Points à considérer

La suppression est définitive. Vérifiez les points suivants avant :

  • Assurez-vous que le coupon n’est pas utilisé dans une campagne active.
  • Si un coupon déjà distribué est supprimé, une erreur apparaîtra lors de son utilisation.
  • Les données analytiques peuvent être supprimées. Sauvegardez-les si nécessaire.