Aller au contenu principal

Lister les coupons d'un modèle

GET

https://api-v2.test.eldowallet.fr/coupons/:id/passes

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.

À retenir
  • Sans status, seuls les coupons active et expired sont renvoyés. Les coupons supprimés sont effacés définitivement et n'apparaissent jamais dans cette liste.

Requête​

path parameters
  • id string required
    Identifiant du modèle de coupon.
query parameters
  • sortOrder string
    Ordre de tri : `asc` (croissant) ou `desc` (décroissant). Par défaut : `desc`.
    enum: asc, descdefault: "desc"
  • status object
    Statut du coupon : `active`, `inactive`, `deleted`, `canceled` ou `expired`. Répétez le paramètre pour filtrer sur plusieurs statuts. Par défaut : `active` et `expired`.
  • createdAtStart string
    Ne renvoie que les coupons créés à partir de cette date (ISO 8601, incluse).
  • search string
    Recherche partielle, insensible à la casse, dans `firstName`, `lastName`, `email` et `barcode`, ainsi que dans l'identifiant du coupon et celui du client.
  • sortBy string
    Champ de tri. Par défaut : `createdAt`.
    default: "createdAt"
  • limit number
    Nombre de résultats par page, de 1 à 1000. Par défaut : 10.
    default: 10min: 1max: 1000
  • page number
    Numéro de la page à renvoyer, à partir de 1. Par défaut : 1.
    default: 1min: 1
header parameters
  • x-lang string
    Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
    enum: en, frdefault: "en"

Réponses​

Schéma application/json
  • docs object[] required
  • totalDocs number required
  • limit number required
  • page number
  • totalPages number required
  • pagingCounter number required
  • hasPrevPage boolean required
  • hasNextPage boolean required
  • prevPage number
  • nextPage number

Les nouveautés de l'API, une fois par mois

Nouveaux endpoints, changements à prévoir, guides et cas d'usage. Pas de spam, désinscription en un clic.

Signaler un problème technique

Une erreur de l’API, un pass qui ne se met pas à jour, un e-mail qui n’arrive pas ? Décrivez le problème : notre équipe technique vous répond.

Pour une réponse rapide, indiquez :

  • La méthode et l’endpoint (ex. POST /clients)
  • Le code d’erreur renvoyé (errorCode) et le corps envoyé
  • La date et l’heure de l’appel
  • Les identifiants concernés (client, modèle, pass)

N’y mettez jamais de jeton d’API ni de mot de passe.

Assistant IA

Beta

Chargement…

Réponses générées par IA (Claude) : vérifiez les points importants.

Connectez-vous pour utiliser l'assistant