Lister les coupons d'un client

GET

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

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.

Requête

path parameters

• clientId string required
  Valeur recherchée (ObjectId de 24 caractères hexadécimaux).

query parameters

• sortOrder string
  Paramètre commun aux listes de coupons ; cette route ne l'utilise pas pour trier les résultats.
  enum: asc, descdefault: "desc"
• status object
  Statut du coupon : `active`, `inactive`, `deleted`, `canceled` ou `expired`. Par défaut : `active` et `expired`.
• createdAtStart string
  Paramètre commun aux listes de coupons ; cette route ne l'utilise pas comme filtre de date.
• search string
  Paramètre commun aux listes de coupons ; cette route ne l'utilise pas comme recherche libre.
• sortBy string
  Paramètre commun aux listes de coupons ; cette route ne l'utilise pas pour trier les résultats.
  default: "createdAt"
• limit number
  Valeur reprise dans le champ `limit` de la réponse. Cette route renvoie tous les résultats dans `docs`, sans découpage en pages.
  default: 10min: 1max: 1000
• page number
  Valeur reprise dans le champ `page` de la réponse. Cette route renvoie tous les résultats dans `docs`, sans découpage en pages.
  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