EcommerceCoupons

Get all your coupon collections

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

limitlongOptionalDefaults to 50
Number of documents returned per page
offsetlongOptionalDefaults to 0
Index of the first document on the page
sortenumOptionalDefaults to desc

Sort the results by creation time in ascending/descending order

Allowed values:
sortByenumOptionalDefaults to createdAt
The field used to sort coupon collections
Allowed values:

Response

Coupon collections
createdAtdatetime
Datetime on which the collection was created.
defaultCouponstring
The default coupon of the collection.
idstringformat: "uuidv4"
The id of the collection.
namestringformat: "uuidv4"
The name of the collection.
remainingCouponslong
Number of coupons that have not been sent yet.
totalCouponslong
Total number of coupons in the collection.
expirationDatedatetime or null
Expiration date for the coupon collection in RFC3339 format.
remainingCouponsAlertinteger or null
If present, an email notification is going to be sent when the total number of available coupons falls below the defined threshold.
remainingDaysAlertinteger or null
If present, an email notification is going to be sent the defined amount of days before to the expiration date.

Errors