List coupon templates

GET

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

Returns the paginated list of coupon templates in your wallet. You can filter by status, name, promo code, template type (single or multiple instance) and creation date, or run a free-text search.

Good to know

• A template whose expirationDate has passed switches to EXPIRED automatically, through a scheduled task. name and promoCode are exact-match filters; use search for a partial match.

Request

query parameters

• sortOrder string
  Sort order: `asc` (ascending) or `desc` (descending). Default: `desc`.
  enum: asc, descdefault: "desc"
• status string
  Template status: `ACTIVE`, `INACTIVE` or `EXPIRED`.
  enum: ACTIVE, INACTIVE, EXPIRED
• name string
  Exact template name (strict, case-sensitive match). For a partial match, use `search`.
• promoCode string
  Exact template promo code (strict match).
• isMultipleInstance boolean
  `true` to return only multiple-instance templates, `false` for single-instance templates.
• createdAtStart string <date-time>
  Only return templates created on or after this date (ISO 8601, inclusive).
• createdAtEnd string <date-time>
  Only return templates created on or before this date (ISO 8601, inclusive).
• search string
  Partial, case-insensitive search in `name`, `description` and `promoCode`, and in the template ID.
• sortBy string
  Field to sort by. Default: `createdAt`.
  default: "createdAt"
• limit number
  Number of results per page, from 1 to 1000. Default: 10.
  default: 10min: 1max: 1000
• page number
  Page number to return, starting at 1. Default: 1.
  default: 1min: 1

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema 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

Schema 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

Schema 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

Schema 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