Fetch Coupons

get

https://platform.nector.io/api/v2/merchant/coupons

Fetch the coupons owned by a customer, i.e. the result of Reward Offer, Redeem Offer or an offer reward trigger. Each coupon carries the code, status, expiry and the offer it was generated from. Refer to this article for the authentication flow when calling this API from a storefront or client side environment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

lead_id

uuid

required

(Required) (This needs to be leads _id value)

offer_id

uuid

(This needs to be coupons offer_id value) (Filter coupons generated from a specific offer)

uuid

(This needs to be coupons _id value)

page

number

≥ 1

(Minimum is 1)

limit

number

1 to 100

(Minimum is 1) (Maximum is 100)

sort

string

enum

(This can only be one of created_at,updated_at)

Allowed:

sort_op

string

enum

(This can only be one of ASC,DESC)

Allowed:

Headers

x-source

string

enum

required

(Required) (This can only be one of mobile,web) (web for browsers and servers, mobile for native apps)

Allowed:

x-apikey

string

required

(Required) (This needs to be your apikey)

x-workspaceid

string

required

(Required) (This needs to be your workspaceid)

x-leadtoken

string

(Required when using a storefront read only api key, not needed with a server api key) (This needs to be the lead_token of the customer, a 1 hour JWT returned by Get User via the x-leaddigest flow or generated on your server with your api signing secret) (When passed, the customer is taken from the token and any lead_id or customer_id in the request is ignored) (Learn more about authentication here)

Responses

200200

5XXUnexpected error on our side. Retry with backoff and share meta.request_id with [email protected] if it persists