Lister les modèles de coupon

GET

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

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.

À retenir

• Un modèle dont la date expirationDate est dépassée passe automatiquement au statut EXPIRED, via une tâche planifiée. name et promoCode sont des filtres exacts ; utilisez search pour une recherche partielle.

Requête

query parameters

• sortOrder string
  Ordre de tri : `asc` (croissant) ou `desc` (décroissant). Par défaut : `desc`.
  enum: asc, descdefault: "desc"
• status string
  Statut du modèle : `ACTIVE`, `INACTIVE` ou `EXPIRED`.
  enum: ACTIVE, INACTIVE, EXPIRED
• name string
  Nom exact du modèle (correspondance stricte, sensible à la casse). Pour une recherche partielle, utilisez `search`.
• promoCode string
  Code promo exact du modèle (correspondance stricte).
• isMultipleInstance boolean
  `true` pour ne renvoyer que les modèles multi-instances, `false` pour les modèles à instance unique.
• createdAtStart string <date-time>
  Ne renvoie que les modèles créés à partir de cette date (ISO 8601, incluse).
• createdAtEnd string <date-time>
  Ne renvoie que les modèles créés jusqu'à cette date (ISO 8601, incluse).
• search string
  Recherche partielle, insensible à la casse, dans `name`, `description` et `promoCode`, ainsi que dans l'identifiant du modèle.
• 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

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