Clients
Porteurs de la carte de fidélité. Créer, importer, mettre à jour, rechercher.
Créer un client
Crée un client et sa carte de fidélité à partir du modèle de carte du wallet. Sans `clientType`, le client reçoit le type par défaut ; sans `barcode`, son identifiant sert de code-barres (si la carte en affiche un). Renvoie le client avec les informations de sa carte (`passId`, `passStatus`, `shortLink`).
Lister les clients
Liste paginée des clients du wallet avec l'état de leur carte de fidélité (`passStatus`, `deviceTypes`, `shortLink`). Combinez la recherche plein texte (`search`), les filtres exacts et le filtre de statut pour retrouver un client ou un segment.
Créer des clients en masse
La réponse est une opération en masse : suivez son statut et ses résultats avec `GET /bulk-operations/{operationId}`.
Mettre à jour des clients 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 clients en masse
La réponse est une opération en masse : suivez son statut et ses résultats avec `GET /bulk-operations/{operationId}`.
Synchroniser les passes de tous les clients
Régénère la carte de fidélité de tous les clients du wallet à partir de leurs données enregistrées, pour réaligner les cartes installées. Indiquez `clientType` pour ne traiter que les clients d'un type. Le traitement est asynchrone : la réponse donne uniquement le nombre de clients à synchroniser (`clientsToSync`).
Obtenir un client par code-barres
Renvoie un client du wallet à partir du code-barres de sa carte de fidélité, avec l'état de sa carte. Pratique en caisse, après le scan de la carte.
Supprimer un client par code-barres
Supprime un client identifié par le code-barres de sa carte de fidélité, ainsi que sa carte. Renvoie les données du client supprimé.
Mettre à jour un client par code-barres
Met à jour un client identifié par le code-barres de sa carte de fidélité. Même comportement que `PATCH /clients/{id}` : seuls les champs envoyés sont modifiés et la carte est mise à jour. Renvoie le client mis à jour.
Mettre à jour les champs spécifiques du pass d'un client
Champs concernés : `overrideStrip`, `additionalInformations`, `barcode`, `altBarcode`.
Mettre à jour un client
Met à jour un client et sa carte de fidélité. Seuls les champs envoyés sont modifiés ; la carte installée sur le téléphone du client est mise à jour en conséquence. Renvoie le client mis à jour.
Obtenir un client
Renvoie un client à partir de son identifiant, avec l'état de sa carte de fidélité (`passStatus`, `deviceTypes`, `shortLink`), le nom de son type (`clientTypeName`) et le statut de ses autres passes.
Supprimer un client
Supprime un client et sa carte de fidélité. Renvoie les données du client supprimé.
Obtenir les statistiques des clients
Renvoie les statistiques des clients du wallet : répartition par source (`crmSource`, `internalSource`, `extrnalSource`), cartes actives et inactives, et cartes actives ou supprimées par plateforme (iOS, Android). Limitez la période avec `startDate` et `endDate` (date de création).
Relancer les clients aux passes inactifs
Envoie un rappel par e-mail et/ou SMS aux clients dont la carte de fidélité est au statut `inactive`. `type: all` cible tous ces clients, `type: specific` uniquement les clients listés dans `ids`. Renvoie le nombre de cartes trouvées (`totalPasses`), de rappels mis en file (`emailsQueued`) et de cartes ignorées (`passesSkipped`).
Mettre à jour les points (gains) d'un client
Remplace le solde de points (`gain`) d'un client et met à jour sa carte de fidélité. Renvoie le client mis à jour.
Mettre à jour les points (gains) d'un client par code-barres
Remplace le solde de points (`gain`) d'un client identifié par le code-barres de sa carte de fidélité. Même comportement que `PATCH /clients/{id}/gain`. Renvoie le client mis à jour.