List the coupons of a client

GET

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

Searches sent coupons using the value passed in clientId: coupons whose barcode equals this value, or whose first name, last name or email contains it. Only coupons with status active or expired are returned.

Request

path parameters

• clientId string required
  Value to search for (24-character hexadecimal ObjectId).

query parameters

• sortOrder string
  Common coupon-list parameter; this route does not use it to sort results.
  enum: asc, descdefault: "desc"
• status object
  Coupon status: `active`, `inactive`, `deleted`, `canceled` or `expired`. Default: `active` and `expired`.
• createdAtStart string
  Common coupon-list parameter; this route does not use it as a date filter.
• search string
  Common coupon-list parameter; this route does not use it as a free-text search.
• sortBy string
  Common coupon-list parameter; this route does not use it to sort results.
  default: "createdAt"
• limit number
  Echoed in the `limit` field of the response. This route returns all results in `docs`, without splitting them into pages.
  default: 10min: 1max: 1000
• page number
  Echoed in the `page` field of the response. This route returns all results in `docs`, without splitting them into pages.
  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