Query coupons independent of customer

Use this endpoint to query coupons within Antavo independently of customer data.
This allows searching for coupons based on criteria such as coupon code and status, providing flexibility in managing coupon data.

Query Params
string

The code used to search for a specific coupon.

string
enum

The status of the coupons to search for.
Options: claimed, redeemed, invalid, expired, unassigned, partially_redeemed

Allowed:
integer
Defaults to 100

Limits the number of results to be returned in one response.

number
Defaults to 0

This parameter gets a specific page of the coupon list if a limit has been set. This is used in pagination in conjunction with the limit query.

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json