List coupons assigned to a customer

Returns all coupons that has been assigned to a specified customer.

Path Params
string
required

Unique customer ID. This can be

  • The Antavo customer ID
  • An external ID (requires configuration): {external_field:external_id_value}
Query Params
string

Filter by the coupon code

string

Filter by the name of the coupon

string
enum

Filter by coupon status. Accepted values: claimed, expired, partially_redeemed and redeemed.

Allowed:
string
enum

Filter by type of coupon. Accepted values: amount, free_shipping, gift_card, percentage.

Allowed:
integer

Filter by the value of coupon.

Responses

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