Coupon

Endpoint: https://app.partnerboost.com/api.php?mod=coupon&op=coupon_list

Version history

V1.1 — 2022/08/03 — Add this
V1.2 — 2023/08/22 — Required Parameter id/mid/track is optional
V1.3 — 2024/03/05 — Add return parameters: creative_id, brand_id, restrictions, keywords, image, thumbnail, smart_url

Key	Description
`token`	Coupon Token

Key	Description
`brand_type`	3 brand types: D2C, Amazon, Indirect
`brand_id`	Brand ID, a series of numbers, like 66303
`mcid`	Unique identifier for the brand, a series of characters, like ulike0
`track`	Track Code in Tracking Link
`type`	Coupons are of 2 types: coupon or deal
`country`	The countries where the coupon can be used
`origin_category`	Category of the merchant which offers the coupon
`level`	Level 1-4, Level 1 is the highest. The higher the level, the more frequent the coupons would update
`lang`	Language of the coupon
`per_page`	Number of items shown per page - default 50, max 2000 items per page
`page`	Current Page Index - Start from 1, and default is 1
`created_at`	Create Time, Format: YYYY-MM-DD
`updated_at`	Update Time, Format: YYYY-MM-DD
`start_at`	Begin Time, Format: YYYY-MM-DD
`end_at`	End Time, Format: YYYY-MM-DD

Key	Description
`id`	Coupon ID
`creative_id`	Creative ID
`brand_id`	Brand ID, a series of numbers, like 66303
`mcid`	Unique identifier for the brand, a series of characters, like ulike0
`restrictions`	Restrictions relating to how the coupon can or cannot be used
`keywords`	Keywords of the coupon
`image`	The image of the coupon
`thumbnail`	The thumbnail of the coupon
`smart_url`	Coupon campaign smart tracking link
`advertiser_name`	Merchant name
`coupon_name`	Coupon Name
`coupon_code`	Code
`description`	Description
`click_url`	Coupon Campaign Tracking Link
`origin_url`	Coupon Original Link
`store_domain`	Host
`type`	Coupons are of 2 types: coupon or deal
`country`	The countries where the coupon can be used
`origin_category`	Category of the merchant which offers the coupon
`level`	Level 1-4, Level 1 is the highest. The higher the level, the more frequent the coupons would update
`lang`	Language of the coupon
`start_at`	Start date
`end_at`	End date
`created_at`	Created time
`updated_at`	Updated time

Request:

{
  "token": "YOUR_COUPON_TOKEN",
  "brand_id": "66303",
  "per_page": 100,
  "page": 1
}