Get Customer Coupons

get

https://{host}/v1.1/customer/coupons

Retrieves the details of coupons (issued, redeemed, expired) of a specific customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

mobile

string

Mobile number of the customer.

string

Email ID of the customer.

external_id

string

External ID of the customer.

int64

Unique ID of the customer.

start_date

date

Get coupons issued or redeemed on or after a specific date (YYYY-MM-DD). To get coupon history of a specific duration, pass the date range in start_date and end_date.

end_date

date

Get coupons issued or redeemed before a specific date (YYYY-MM-DD). To get coupon history of a specific duration, pass the date range in start_date and end_date.

status

string

enum

Retrieve coupons by coupon status. active is based on the coupon expiry date and does not validate redemptions. Hence you will see all coupons whose expiry (valid_till) is a future date.

Allowed:

series_id

int32

Retrieve details of a specific coupon series by series id.

store_id

string

Retrieves the details of active coupons of the customer that can be redeemed at a specific store.

order_by

string

enum

"valid_till" is used to filter coupons by their validity. Use "sort_order" alongside this to sort the results in ascending or descending order of coupon validity.

Allowed:

sort_order

string

enum

Sort the results in ascending (asc) or descending (desc) order of order_by.

Allowed:

limit

int32

Limit the number of results to be retrieved. For example: limit=10 to retrieve the history of ten recent coupons of the customer.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400