Coupons
Modèles de coupons et coupons envoyés.
Créer un modèle de coupon
Crée un modèle de coupon dans votre wallet et le modèle de pass associé. La requête est envoyée en `multipart/form-data` avec l'image du bandeau (`strip`). Le modèle créé est renvoyé ; utilisez ensuite `POST /coupons/{id}/passes/send` pour envoyer des coupons à vos clients.
Lister les modèles de coupon
Renvoie la liste paginée des modèles de coupon de votre wallet. Vous pouvez filtrer par statut, nom, code promo, type de modèle (instance unique ou multi-instance) et date de création, ou faire une recherche libre.
Mettre à jour un modèle de coupon
Met à jour un modèle de coupon et le modèle de pass associé ; les coupons déjà envoyés sont mis à jour en conséquence. Accepte `application/json` ou `multipart/form-data` (pour remplacer l'image `strip`). Attention : si vous n'envoyez pas `expirationDate`, la date d'expiration du modèle est effacée.
Supprimer un modèle de coupon
Supprime définitivement un modèle de coupon et son modèle de pass. Renvoie le modèle supprimé.
Obtenir un modèle de coupon
Renvoie un modèle de coupon à partir de son identifiant. Renvoie `MODEL_NOT_FOUND` si le modèle n'existe pas.
Lister les coupons d'un modèle
Renvoie la liste paginée des coupons envoyés à partir d'un modèle. Par défaut, seuls les coupons au statut `active` ou `expired` sont renvoyés, du plus récent au plus ancien.
Envoyer des coupons
Envoie un coupon à des clients existants ou à des destinataires qui ne sont pas clients. Avec `clientId`, les données de la carte de fidélité du client sont utilisées ; sans `clientId`, `firstName`, `lastName` et `email` sont obligatoires. Accepte `multipart/form-data` pour remplacer l'image du bandeau. `webhookUrl` et `forceSync` sont facultatifs. La réponse est une opération en masse : suivez son statut et ses résultats avec `GET /bulk-operations/{operationId}`.
Obtenir un coupon
Renvoie un coupon envoyé, identifié par son modèle et son `instanceId`. Renvoie `PASS_NOT_FOUND` si aucun coupon de ce modèle ne correspond.
Mettre à jour un coupon
Met à jour les valeurs propres à un coupon envoyé : `promoCode`, `description`, `value`, `expirationDate` et `bannerOverrideUrl`. Seuls les champs fournis sont modifiés ; les autres valeurs restent celles du coupon ou, à défaut, du modèle. Renvoie le coupon mis à jour.
Supprimer un coupon
Supprime définitivement un coupon envoyé. Sur un modèle multi-instance, cet appel supprime tout le modèle et tous ses coupons (voir ci-dessous).
Faire expirer un coupon
Fait expirer immédiatement un coupon envoyé : son statut passe à `expired` et sa date d'expiration devient la date du jour. Renvoie le coupon mis à jour, ou `PASS_ALREADY_EXPIRED` s'il est déjà expiré.
Modifier le statut d'un coupon
Statuts possibles : `EXPIRED`, `USED`, `UNUSED`.
Lister les coupons d'un client
Recherche des coupons envoyés à partir de la valeur passée dans `clientId` : coupons dont le code-barres est égal à cette valeur, ou dont le prénom, le nom ou l'e-mail la contient. Seuls les coupons au statut `active` ou `expired` sont renvoyés.
Obtenir les statistiques des coupons d'un modèle
Renvoie deux compteurs pour un modèle de coupon : le nombre de coupons envoyés (`countOfSentCouponPasses`) et le nombre de coupons ajoutés à un wallet mobile (`countOfDownloadedPasses`).
Mettre à jour des coupons en masse
La réponse est une opération en masse : suivez son statut et ses résultats avec `GET /bulk-operations/{operationId}`.
Supprimer des coupons en masse
La réponse est une opération en masse : suivez son statut et ses résultats avec `GET /bulk-operations/{operationId}`.