Lister les clients

GET

https://api-v2.test.eldowallet.fr/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.

À retenir

• firstName, lastName, email, barcode et phoneNumber sont des filtres exacts ; utilisez search pour une recherche partielle, insensible à la casse. Les paramètres status, createdAtStart et de tri portent sur la carte de fidélité du client.

Requête

query parameters

• sortOrder string
  Ordre de tri : `asc` ou `desc`. Par défaut : `desc`.
  enum: asc, descdefault: "desc"
• status string[]
  Statut de la carte de fidélité : `active`, `inactive`, `deleted`, `canceled` ou `expired`. Répétez le paramètre pour combiner plusieurs statuts.
• createdAtStart string <date-time>
  Ne renvoie que les clients dont la carte a été créée à cette date ou après (ISO 8601).
• email string <email>
  E-mail exact du client.
• barcode string
  Code-barres exact du client.
• phoneNumber string
  Numéro de téléphone exact du client, tel qu'il a été enregistré.
• firstName string
  Prénom exact du client (sensible à la casse). Pour une recherche partielle, utilisez `search`.
• lastName string
  Nom exact du client (sensible à la casse). Pour une recherche partielle, utilisez `search`.
• search string
  Recherche partielle, insensible à la casse, sur le prénom, le nom, l'e-mail, le code-barres, le téléphone et l'identifiant du client.
• sortBy string
  Champ de tri de la carte de fidélité : `createdAt` (par défaut), `updatedAt`, `_id`, `status` ou `expirationDate`. Toute autre valeur revient à un tri par `createdAt`.
  default: "createdAt"
• limit number
  Nombre de clients par page, de `1` à `1000`. Par défaut : `10`.
  default: 10min: 1max: 1000
• page number
  Numéro de page, à 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

200

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

401

UNAUTHORIZED

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email