Retrieve the list of a customer's coupons

get

https://read-api.<environment>.antavo.com/v1/customers/{customer_id}/coupons

Returns a paginated list of coupons associated with a specific customer.
Results can be filtered by status, claimed_at, redeemed_at, expiration_date coupon attribute values, and sorted by claimed_at, redeemed_at, expiration_date values.

Path Params

customer_id

string

required

Customer identifier. Using an external ID is not supported.

Query Params

offset

integer

≥ 0

Defaults to 0

Offsets the starting position in the sorted result set. Used for pagination together with the limit query parameter.

limit

integer

1 to 1000

Defaults to 20

Sets the maximum number of items to return from the sorted result set. Used for pagination together with the offset query parameter.

filter

object

Filter by allowed fields and operators.

sort

array of objects

Sorts results by one or more fields in the specified order. Each field can be used only once.
When multiple sort instructions are provided, the first field is used as the primary sort field. Each additional field determines the order of results that have the same value for the preceding field.
Example: ?sort[0][field]=claimed_at&sort[0][direction]=asc&sort[1][field]=redeemed_at&sort[1][direction]=desc

sort

Responses

Language

Loading…

Response

Choose an example:

application/json

200Success - Coupon data provided

401Error - Escher signature missing or invalid.

422Error - Request validation failed.

5XXError - Unexpected server error.