PartnerBoost API Documentation

Integrate your systems with PartnerBoost's partnership management platform. Our API enables you to manage transactions, generate reports, handle creatives, and manage your product datafeed programmatically.

Read the Guide

Authentication

The PartnerBoost API currently supports a number of different actions. All requests should be made as a HTTPS GET or POST (JSON) request to:

https://app.partnerboost.com/api/brand

Required Parameters

  • bid - Your brand ID number
  • token - Unique token received when account is set up for API use
  • action - One of the supported actions
  • version - Currently 1.0

Required Headers

  • Content-Type - application/json
  • X-PARTNERBOOST-DATE - The current date in UTC (Universal Time Code)
  • X-PARTNERBOOST-AUTHENTICATION - The calculated authentication hash

Authentication Hash

The Authentication Hash is a SHA-256 Hash in 64 character Hex format of the string:

YourAPIToken;APIActionValue;CurrentDateInUTCFormat;YourAPISecret
Example

For the following values:

  • API Action: order/new
  • Token: a25fb1225425ae360ec2922286e7bd01
  • API Secret: 65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c
  • UTC Date: Fri, 07 Jan 2022 07:21:16 GMT
  • String to Hash: a25fb1225425ae360ec2922286e7bd01;order/new;Fri, 07 Jan 2022 07:21:16 GMT;65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c

Correct HTTP Headers

  • X-PARTNERBOOST-DATE: Fri, 07 Jan 2022 07:21:16 GMT
  • X-PARTNERBOOST-AUTHENTICATION: c0603ea2f4bd66eaac5e6fbbd2093ea6426d7e13e0a8cc4f5550368f55f7e64a

Transaction API

POST order/new Create a new transaction
Key 职位 Example Required Type
order_number Your unique order number 201000000001 Yes string
pbtid PartnerBoost click track code x_xxxxx No string
is_new_customer Is new customer in brand false No bool
uid User identity in brand 453215 No string
currency Order currency USD Yes string
trans_time Order transaction time Thu, 20 Jan 2022 05:27:30 GMT Yes string
amount Actual order amount 111.55 No double
quantity Quantity of products 1 No int
remark Any message No string
couponcode Comma-delimited list of coupon codes ZVKD234,ZVKA111 No string
skus SKU list (required when order has SKU) Array No array
Request Demo
{ "order_number": "RMD17ea9a09be7c4bd4101aa3d21df80b47", "currency": "CNY", "trans_time": "Thu, 20 Jan 2022 05:27:30 GMT", "pbtid": "ldc_xdw3", "skus": [ { "id": "1df80b47", "name": "Mi book", "amount": 2776, "quantity": 12 } ] }
Response Demo
{ "code": 0, "data": "210120052732256X22", "msg": "success" }
POST order/void Void transaction
Key 职位 Example Required Type
order_number Your unique order number 201000000001 Yes string
Request Demo
{ "order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234" }
Response Demo
{ "code": 0, "data": "", "msg": "success" }
POST order/effective Effective transaction
Key 职位 Example Required Type
order_number Your unique order number 201000000001 Yes string
Request Demo
{ "order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234" }
Response Demo
{ "code": 0, "data": "", "msg": "success" }
POST order/bonus Give bonus to publisher
Key 职位 Example Required Type
medium_id Publisher identity LDC000123 Yes string
currency Order currency USD Yes string
trans_time Order transaction time Thu, 20 Jan 2022 05:27:30 GMT Yes string
commission Commission for publisher 11.15 Yes double
remark Any message No string
Request Demo
{ "medium_id": "LDC0012346", "currency": "CNY", "trans_time": "Thu, 20 Jan 2022 05:27:30 GMT", "commission": 416.4 }
Response Demo
{ "code": 0, "data": "210120052732256X22", "msg": "success" }

Report API

POST report/clicks_list Clicks list
Key 职位 Example Required Type
start_time Start timestamp 1650351153 No int
end_time End timestamp 1670351153 No int
first First 0 No int
page_size Page size from 20 to 100 20 No int
publisher_id Publisher ID No string
channel_id Channel ID No string
Request Demo
{ "first": 720078 }
Response Demo
{ "code": 0, "data": { "pageInfo": { "hasNextPage": true, "endCursor": "720131", "startCursor": "720107" }, "list": [ { "id": "720107", "pbtid": "pb_xxt0", "ip": "217.143.18.13", "location": "CA", "referer": "https://example.com", "usource": "PC", "useragent": "Mozilla/5.0...", "publisher_id": "50153", "publisher_name": "meimei", "channel_id": "4493", "channel_name": "yuyao", "landing_page": "", "created_timestamp": "1648692632", "created_time": "Thu, 31 Mar 2022 02:10:32 GMT" } ] }, "msg": "success" }
POST report/clicks_detail Clicks detail
Key 职位 Example Required Type
id Transfer ID (one of id and pbtid is required) 720078 No int
pbtid Tracking flag from landing URL (one of id and pbtid is required) pb_xxxx No string
Request Demo
{ "id": 720112 }
Response Demo
{ "code": 0, "data": { "id": "720107", "pbtid": "pb_xxt0", "ip": "217.143.18.13", "location": "CA", "referer": "https://app.partnerboost.com/publisher/payments/transaction_inquiries?act=new", "usource": "PC", "useragent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.60 Safari/537.36", "publisher_id": "50153", "publisher_name": "meimei", "channel_id": "4493", "channel_name": "yuyao", "landing_page": "", "created_timestamp": "1648692632", "created_time": "Thu, 31 Mar 2022 02:10:32 GMT" }, "msg": "success" }
POST report/order_list Order list
Key 职位 Example Required Type
start_time Transaction timestamp 1650351153 No int
end_time Transaction timestamp 1670351153 No int
page_number Page number 1 No int
page_size Page size from 20 to 100 20 No int
sort_dir enum(desc, asc), default is desc desc No enum
sort_col enum(transid, commission, amount) transid No enum
status enum(new, void, effective) No enum
type Transaction type No enum
Request Demo
{ "status": "effective" }
Response Demo
{ "code": 0, "msg": "success", "data": { "total": "1", "list": [ { "id": "316", "order_id": "12123121", "publisher_id": 50034, "channel_id": 4480, "coupon_code": "", "transaction_type": "trans", "status": "effective", "transaction_time": "Wed, 20 Apr 2022 08:04:23 GMT", "transaction_timestamp": 1650441863, "track_code": "", "currency": "USD", "sale_amount": 135.7, "network_fee": 3.05, "commission": 20.35, "total_spend": 23.4, "ori_currency": "CNY", "ori_sale_amount": 864.36, "ori_network_fee": 19.44, "ori_commission": 129.65, "ori_total_spend": 149.09, "skus": [ { "sku": "b219ac3d", "status": "effective", "quantity": 12, "commission_id": "0", "currency": "USD", "sale_amount": 68.64, "network_fee": 1.54, "commission": 10.29, "total_spend": 11.83, "ori_currency": "CNY", "ori_sale_amount": 437.22, "ori_network_fee": 9.83, "ori_commission": 65.58, "ori_total_spend": 75.41 } ] } ] } }
POST report/transaction_list Transaction list
Key 职位 Example Required Type
limit Amount per page (max 200, default 100) 100 No int
cursor Cursor for pagination 1 Yes string
start_date Start date (YYYYMMDD) 20241101 No string
end_date End date (YYYYMMDD) 20241101 No string
order_status Order status new, void, mixed, locked, paid No string
sku_status SKU/ASIN status new, void, locked, paid No string
transaction_type Transaction type bonus, manually_added, normal No string
publisher_id Publisher ID No string
group_id Group ID assigned to publishers 323 No string
Request Demo
{ "limit": 100, "cursor": "1", "start_date": "20241101", "end_date": "20241130", "order_status": "locked" }
Response Demo
{ "code": 0, "msg": "success", "data": { "list": [ { "order_id": "C1TZX-95VVFA5R95", "order_status": "locked", "date": "2024-11-07 05:00:00", "currency": "USD", "publisher_id": "180716", "publisher_name": "haar1", "sku_list": [ { "sku_status": "locked", "sku": "B0CJM2W42K", "quantity": "2", "sales_amount": "100.00", "commission": "27.00" } ] } ], "count": 1, "cursor": null } }

Creative API

POST creative/list Creative List
Key 职位 Example Required Type
type Type IMAGE/TEXT/COUPON Yes string
status Status Scheduled/Active/Expired No Array
privacy Permission PUBLIC/PRIVATE No Array
keyword Keyword test No string
page_num Page Number 1 No int
page_size Page Size 10 No int
Request Demo
{ "type": "IMAGE", "status": ["Active"], "privacy": ["PUBLIC"], "keyword": "test", "page_num": 1, "page_size": 10 }
Response Demo
{ "data": { "total_size": 1, "total_page": 1, "page_size": 28, "page_num": 1, "current_size": 1, "data": [ { "id": "132505", "mid": "partnerboost", "start_time": "1680241332", "end_time": "1682574132", "title": "test", "privacy": "PUBLIC", "type": "IMAGE", "category": "cate", "link": "https://www.example.com", "created_time": "1679636639", "updated_time": "1679636659", "deleted_time": "0", "is_deleted": "0", "status": "Active", "images": [ { "creative_id": "132505", "image_url": "https://example/img.png", "width": "2880", "height": "1800", "alternate": "", "size": "957112" } ] } ] }, "code": 0, "message": "ok" }
POST creative/create Upload Creative
Key 职位 Example Required Type
type Type IMAGE/TEXT/COUPON Yes string
start_time Start Time 1680241332 Yes string
end_time End Time 1682574132 Yes string
link Link (Required when type == TEXT) https://www.example.com No string
content Content (Required when type == TEXT) test No string
images Images (Required when type == IMAGE) Array No Array
title 职位 test No string
privacy Privacy PUBLIC/PRIVATE No string
Request Demo
{ "title": "bnane", "category": "cate", "privacy": "PUBLIC", "site_ids": [], "start_time": 1681282362, "end_time": 1683874362, "type": "TEXT", "images": [ { "width": 225, "height": 225, "url": "https://cdn-test.55haitao.com/data/upload/image/20230412/20230412160510_94131.jpeg", "size": 10500 } ], "link": "http://example.com", "highligh": [], "preview": null, "content": "test" }
Response Demo
{ "code": 0, "data": [ 132508 ], "msg": "success" }
POST creative/modify Edit Creative
Key 职位 Example Required Type
id ID 132505 Yes string
title 职位 test No string
start_time Start Time 1680241332 No string
end_time End Time 1682574132 No string
privacy Privacy PUBLIC/PRIVATE No string
Request Demo
{ "id": "132505", "title": "test", "category": "cate", "privacy": "PUBLIC", "start_time": "1680241332", "end_time": "1682574132" }
Response Demo
{ "code": 0, "data": null, "msg": "success" }

Datafeed API

POST datafeed/get_info Get Datafeed Info
Request Demo
{}
Response Demo
{ "code": 0, "data": { "last_updated": "1653546984", "last_uploaded_time": "1653466305", "max_upload_num_per_month": "10", "num_products": "9", "fetch_url": "http://www.yousite.com/datafeed.xml", "fetch_period": "DAILY", "last_fetch_time": "1653552418", "last_fetch_status": "XML parse error", "updated_time": "1653882623", "parsing_files_num": 0, "uploaded_this_month": 8 }, "msg": "success" }
POST datafeed/update_setting Update Datafeed Setting
Key 职位 Example Required Type
fetch_period Fetch Period (NEVER, DAILY, WEEKLY, MONTH) DAILY Yes string
fetch_url Fetch URL http://www.yousite.com/datafeed.xml Yes string
Request Demo
{ "fetch_period": "DAILY", "fetch_url": "http://www.yousite.com/datafeed.xml" }
Response Demo
{ "code": 0, "data": null, "msg": "success" }
POST datafeed/update_product Update or Add a Product
Key 职位 Example Required Type
name Product Name Product Name Yes string
url Product URL http://www.yousite.com/product/1 Yes string
image Product Image http://www.yousite.com/product/1.jpg Yes string
sku Product SKU (unique) SKU Yes string
price Product Price 100 Yes number
currency Currency Code (ISO 4217) USD Yes string
description Product Description Product Description No string
category Product Category Category No string
old_price Product Old Price 100 No number
brand Product Brand 品牌 No string
gtin Global Trade Identification Number 9783161484100 No string
mpn Manufacturer Part Number CR2032 No string
availability Product Availability In Stock No string
Request Demo
{ "name": "Product Name", "description": "Product Description", "url": "http://www.yousite.com/product/1", "image": "http://www.yousite.com/product/1.jpg", "sku": "SKU", "category": "Category", "price": 100, "currency": "USD", "old_price": 100, "brand": "Brand", "gtin": "9783161484100", "mpn": "CR2032", "availability": "In Stock" }
Response Demo
{ "code": 0, "data": "Added", "msg": "success" }

Publisher API

POST publisher/list Publisher List
Key 职位 Example Required Type
publisher_id Publisher ID 9527 No int
channel_id Channel ID 9527 No int
status Status joined No string
Request Demo
{ "publisher_id": 9527, "apply_status": "joined", "channel_id": 9527 }
Response Demo
{ "code": 0, "msg": "success", "data": [ { "publisher_id": "109271", "publisher_name": "aaa_bai", "description": "", "channel_list": [ { "medium_id": "PB00040837", "channel_id": "40837", "status": "adopt", "title": "s1", "host": "http://s1.host", "word": ",2123,2413213", "userid": "109271", "c_id": "", "c_category_id": "6" } ], "keywords": [ "2123", "2413213", "s2", "s4" ], "category": [ "Food & Drink" ], "promotion_method": [] } ] }
POST publisher/maintenance Publisher Maintenance
Key 职位 Example Required Type
userId User ID (One of userId and site_ids is required) 40828 Yes string
site_ids Site IDs (One of userId and site_ids is required) 40828 Yes string
mail_id Mail ID 40828 No string
auto_approve Auto Approve 1 No int
status Status (adopt/unblock/terminated/refuse) adopt Yes string
Request Demo
{ "site_ids": "40828", "auto_approve": 1, "status": "adopt" }
Response Demo
{ "code": 0, "data": null, "msg": "success" }

Authentication

Publisher API requests should be made to the following endpoint:

https://app.partnerboost.com/api.php?mod=medium&op={action}

HTTP Request Methods

  • POST application/x-www-form-urlencoded
  • POST application/json
  • GET

Return Format

  • JSON (default)
  • XML

Required Parameter

  • token - Your channel API token (found in your Publisher Dashboard)
Note

Each channel has its own unique API token. You can find your tokens in the Publisher Dashboard under Tools > API.

Common Result Codes

编码 描述
0 Success
1000 Publisher does not exist
1001 Invalid token
1002 Call frequency too high
1003 Missing required parameters or incorrect format
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_type": "DTC", "relationship": "Joined" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "brand_id": "66303", "mcid": "joes", "merchant_name": "Joe's Jeans", "brand_type": "DTC", "approval_type": "Auto", "offer_type": "CPS", "categories": "Apparel" } ] }

Transaction

POST transaction Get Transaction List

Pull detailed transactions, commission status and many more.

Endpoint
https://app.partnerboost.com/api.php?mod=medium&op=transaction

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d
begin_date Transaction period start. Either transaction period or validation period is mandatory. 2024-01-01
end_date Transaction period end 2024-01-31
validation_date_begin Validation period start. Either transaction period or validation period is mandatory. 2024-01-01
validation_date_end Validation period end 2024-01-31

Optional Parameters

Key 描述 Example
type Return format: json (default) or xml json
order_id Order ID ORD123456
status Commission Status: Pending, Approved, Rejected, Normal, All Approved
uid Your custom tracking variable tracking123
brand_id Brand ID 66303
mcid Unique identifier for the brand ulike0
page Current page index 1
limit Number of transactions per page (max 2000) 100

Return Parameters

Key 描述
channel_id Channel ID
total_page Total number of pages
total_trans Total number of sales transactions
brand_id Brand ID
mcid Unique identifier for the brand
merchant_name Brand Name
order_id Order ID
order_time Transaction Time
sale_amount Sale Amount
sale_comm Sale Commission
status Commission Status
uid Your custom tracking variable
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "begin_date": "2024-01-01", "end_date": "2024-01-31", "status": "Approved" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": { "channel_id": "500107", "total_page": "1", "total_trans": "1", "list": [ { "brand_id": "66303", "mcid": "joes", "merchant_name": "Joe's Jeans", "order_id": "ORD123456", "order_time": "1704067200", "sale_amount": "100.00", "sale_comm": "10.00", "status": "Approved", "uid": "tracking123" } ] } }

Click Report

POST transfer Get Click Report

Pull detailed click log.

Endpoint
https://app.partnerboost.com/api.php?mod=medium&op=transfer

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d
begin_date Start date and time 2024-01-01 00:00:00
end_date End date and time 2024-01-01 01:00:00
Rate Limit

The span of start and end date parameter values cannot exceed one hour. Maximum 10 requests per minute.

Return Parameters

Key 描述
channel_id Channel ID
total_page Total number of pages
total_items Total transactions broken down by items
brand_id Brand ID
mcid Unique identifier for the brand
merchant_name Brand Name
uid Your custom tracking variable
click_time The time the customer clicks your link (UTC+8)
click_ref A unique transaction reference identification
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "begin_date": "2024-01-01 00:00:00", "end_date": "2024-01-01 01:00:00" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": { "total_items": 1, "list": [ { "channel_id": "PB00039713", "click_time": "2022-11-01 14:49:17", "merchant_name": "24S Worldwide", "brand_id": "66303", "mcid": "24sevres", "click_ref": "pb_xx95", "uid": "" } ] } }

Commission

POST merchant_commission Commission Validation API

Shows approved commission breakdown by brand on a monthly basis.

Endpoint
https://app.partnerboost.com/api.php?mod=settlement&op=merchant_commission

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d
begin_date Start date 2024-01-01
end_date End date 2024-01-31

Return Parameters

Key 描述
brand_id Brand ID
mcid Unique identifier for the brand
sale_comm Sale Commission
settlement_date Date when commission is approved and ready for withdrawal
note Time period the amount is generated
settlement_id Unique ID indicates approved commission by merchant
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "begin_date": "2024-01-01", "end_date": "2024-01-31" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "brand_id": "66303", "mcid": "joes", "sale_comm": "37.73", "settlement_date": "2018-04-27", "note": "2016-01-01 ~ 2016-01-31, joes Sales Commission", "settlement_id": "810b2ce13d1a3b640423" }, { "brand_id": "66304", "mcid": "finishline", "sale_comm": "17.45", "settlement_date": "2018-04-27", "note": "2016-01-01 ~ 2016-01-31, finishline Sales Commission", "settlement_id": "c32ff2f5ec5553bb0423" } ] }
POST commission_details Commission Details API

Use settlement ID to retrieve commission breakdown by transactions per brand.

Endpoint
https://app.partnerboost.com/api.php?mod=settlement&op=commission_details

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d
settlement_id Unique ID indicates approved commission by merchant 12345

Return Parameters

Key 描述
brand_id Brand ID
mcid Unique identifier for the brand
merchant_name Brand Name
order_id Order ID
order_time Transaction Time
sale_amount Sale Amount
sale_comm Sale Commission
status Commission Status
uid Your custom tracking variable
prod_id Product ID
order_unit Order Unit Amount
settlement_id Unique ID indicates approved commission
validation_date Date the transaction validated
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "settlement_id": "12345" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "brand_id": "66306", "mcid": "katespade", "merchant_name": "Kate Spade", "order_id": "8720334", "order_time": "1502949706", "sale_amount": "69.00", "sale_comm": "5.52", "status": "Approved", "uid": "120802|00yl70cf45100529c704", "prod_id": "098687062527", "order_unit": "1", "settlement_id": "804a15b9ac6f5fa11113", "validation_date": "2021-04-05", "note": "order returned" } ] }

付款方式

POST payment_summary Payment Summary API

Shows your payment history.

Endpoint
https://app.partnerboost.com/api.php?mod=medium&op=payment_summary

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d
payment_id Payment ID (payment_id or paid_date_begin and paid_date_end are mandatory) 12345
paid_date_begin Paid date period start (YYYY-MM-DD) 2024-01-01
paid_date_end Paid date period end (YYYY-MM-DD) 2024-01-31

Return Parameters

Key 描述
payment_id The payment ID found under payment history
request_date Date when the payment has been created
paid_date Date when the payment is marked paid
payment_type Payment type
payment_details Account information
invoice Invoice information
Amount Payment amount
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "paid_date_begin": "2024-01-01", "paid_date_end": "2024-01-31" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": { "total_items": "5", "list": [ { "payment_id": "3949", "request_date": "2023-10-10", "paid_date": "2023-10-10", "invoice": "", "amount": "$20.00", "payment_details": "500107", "payment_type": "Bank Wire" }, { "payment_id": "3952", "request_date": "2023-10-10", "paid_date": "2023-10-10", "invoice": "", "amount": "$30.00", "payment_details": "500107", "payment_type": "Bank Wire" } ], "page": 100, "limit": 1 } }
POST payment_detail Payment Detail API

Shows your detailed payment.

Endpoint
https://app.partnerboost.com/api.php?mod=medium&op=payment_detail

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d
payment_id Payment ID (payment_id or paid_date_begin and paid_date_end are mandatory) 12345
paid_date_begin Paid date period start (YYYY-MM-DD) 2024-01-01
paid_date_end Paid date period end (YYYY-MM-DD) 2024-01-31

Return Parameters

Key 描述
brand_id Brand ID
mcid Unique identifier for the brand
amount Commission amount or bonus amount
validation_date Date when commission is approved
type Type could be commission or bonus
note Time period the amount is generated
settlement_id Unique ID indicates approved commission
merchant_name Merchant Name
payment_id The payment ID found under payment history
paid_date Date when the payment is marked paid
sign_id Record unique identifier
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "payment_id": "3949" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "brand_id": "66306", "mcid": "katespade", "merchant_name": "Kate Spade", "amount": "20.00", "validation_date": "2023-10-10", "type": "commission", "note": "2023-09-01 ~ 2023-09-30", "settlement_id": "804a15b9ac6f5fa11113", "payment_id": "3949", "paid_date": "2023-10-10", "sign_id": "12345" } ] }

Monetization

POST monetization_api Monetization API

Check brand details status and acquire campaign links to monetize your traffic.

Endpoint
https://app.partnerboost.com/api.php?mod=medium&op=monetization_api

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d

Optional Parameters

Key 描述 Example
type Return format: json (default) or xml json
brand_type Brand types: TikTok, DTC, Amazon, Walmart, Indirect DTC
approval_type Filter by approval type: Auto, Manual Auto
offer_type Filter by brand pricing model: CPS, CPA, CPC, CPL, CPX, CPM CPS
relationship Filter by current brand relationship: Joined, Pending, Rejected, No Relationship Joined
categories Filter by brand categories Apparel
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_type": "DTC", "relationship": "Joined" }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "brand_id": "66303", "mcid": "joes", "merchant_name": "Joe's Jeans", "brand_type": "DTC", "approval_type": "Auto", "offer_type": "CPS", "categories": "Apparel" } ] }

Coupon

POST coupon_list Coupon API

Get available coupons and deals from brands.

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

Required Parameters

Key 描述 Example
token Coupon Token 79e33f8dac5a0be8579018760cff4cc227fb888d

Optional Parameters

Key 描述 Example
brand_type 3 brand types: D2C, Amazon, Indirect D2C
brand_id Brand ID 66303
mcid Unique identifier for the brand ulike0
track Track Code in Tracking Link track123
type Coupons are of 2 types: coupon or deal coupon
country The countries where the coupon can be used 美国
origin_category Category of the merchant which offers the coupon Apparel
level Level 1-4, Level 1 is the highest 1
lang Language of the coupon en
per_page Number of items per page (default 50, max 2000) 100
page Current Page Index (starts from 1) 1
created_at Create Time (YYYY-MM-DD) 2024-01-01
updated_at Update Time (YYYY-MM-DD) 2024-01-01

Return Parameters

Key 描述
creative_id Creative ID
brand_id Brand ID
restrictions Coupon restrictions
keywords Keywords
image Coupon image
thumbnail Thumbnail image
smart_url Smart URL
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_id": "66303", "per_page": 100, "page": 1 }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "creative_id": "12345", "brand_id": "66303", "restrictions": "Minimum purchase $50", "keywords": "fashion, apparel", "image": "https://example.com/coupon.jpg", "thumbnail": "https://example.com/thumb.jpg", "smart_url": "https://partnerboost.com/smart/abc123" } ] }

Datafeed

POST list Datafeed List API

Get product datafeed from brands.

Endpoint
https://app.partnerboost.com/api.php?mod=datafeed&op=list

Required Parameters

Key 描述 Example
token Your channel API token 79e33f8dac5a0be8579018760cff4cc227fb888d

Optional Parameters

Key 描述 Example
type Return format: json (default) or xml json
brand_type Brand types: TikTok, DTC, Walmart DTC
brand_id Brand ID 66303
mcid Unique identifier for the brand ulike0
page Current Page Index 1
limit Number of products per page (max 100) 50
keywords Keywords shirt
price_range One of "0-75", "75-150", "150-300", "300-500", "500-1000", "1000+" 75-150
min_discount One of 75, 50, 25, 10 25

Return Parameters

Key 描述
name Product name
description Product description
brand_id Brand ID
mcid Unique identifier for the brand
merchant_name The name of the merchant selling this product
url The original product url
image The link to the image of the product
sku SKU of the product
category Product category
price Current price of the product
tracking_url Affiliate tracking URL
tracking_url_short Short affiliate tracking URL
tracking_url_smart Smart affiliate tracking URL
updated_at Last update time
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_type": "DTC", "limit": 50, "page": 1 }
Response Demo
{ "status": { "code": 0, "msg": "Success" }, "data": [ { "name": "Classic Cotton T-Shirt", "description": "Comfortable cotton t-shirt", "brand_id": "66303", "mcid": "joes", "merchant_name": "Joe's Jeans", "url": "https://example.com/product/123", "image": "https://example.com/images/product.jpg", "sku": "SKU12345", "category": "Apparel", "price": "29.99", "tracking_url": "https://partnerboost.com/track/abc123", "tracking_url_short": "https://pb.co/abc", "tracking_url_smart": "https://partnerboost.com/smart/abc123", "updated_at": "2024-01-15 10:30:00" } ] }

亚马逊

Amazon Publisher API base URL: https://amazon-service.partnerboost.com/amazon_api. All endpoints below use POST with JSON body application/json.

POST get_fba_products Get Products API

Filter and search Amazon products by criteria (pagination, country, brand, ASINs, promos, etc.).

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_products
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 20, "page": 1, "default_filter": 0, "country_code": "", "brand_id": null, "sort": "", "asins": "", "relationship": 1, "is_original_currency": 0, "has_promo_code": 0, "has_acc": 0, "filter_sexual_wellness": 0 }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": { "list": [ { "product_id": "007d030d256e3e35774d65822f89c778", "product_name": "Example Product", "asin": "B0CQT26VCW", "commission": "10%", "category": "Appliances", "url": "https://www.amazon.com/dp/B0CQT26VCW", "brand_id": "90863", "country_code": "US" } ], "has_more": true } }
POST get_fba_products_link Get Products Link (Product ID) API

Generate tracking links from product IDs returned by Get Products API.

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_products_link
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "product_ids": "007d030d256e3e35774d65822f89c778", "uid": "123" }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": [ { "product_id": "007d030d256e3e35774d65822f89c778", "link": "https://www.amazon.com/dp/B0CQT26VCW?maas=...", "link_id": "5a19kG_aIdGFJrujZS3rjehf1RoROk2O8_bveeZQSggsULwwlmW2JT7vMOckEw0A_a1I_bNTErmMiVHobJT9S53Tvx7WFDtBnEGLhIcLwA8_c" } ], "error_list": [ { "product_id": "111", "message": "Product not found or no relationship" } ] }
POST get_amazon_link_by_asin Get Products Link (ASIN) API

Generate product tracking links using ASINs and marketplace.

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_link_by_asin
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "asins": "B0CQT26VCW", "country_code": "US", "uid": "", "return_partnerboost_link": 0 }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": [ { "asin": "B0CQT26VCW", "link": "https://www.amazon.com/dp/B0CQT26VCW?maas=...", "partnerboost_link": "", "link_id": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c" } ], "error_list": [ { "asin": "B0CQ2JMS731", "country_code": "US", "message": "Product not found or no relationship" } ] }
POST get_amazon_joined_brands Get Partnered Brands API

List Amazon brands you are partnered with (paginated).

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_joined_brands
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "bids": "90863", "page_size": 20, "page": 1 }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": { "list": [ { "bid": "90863", "brand_name": "Midea_US", "support_storefront_link": "yes" } ], "hasMore": false } }
POST get_fba_brand_link Get Storefront Link API

Generate storefront tracking links from brand IDs (bids).

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_brand_link
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "bids": "90863", "uid": "zxf" }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": [ { "bid": "90863", "brand_name": "Midea_US", "storefront_link": "https://www.amazon.com/stores/page/...", "storefront_short_link": "https://pboost.me/JqLDkvht?uid=zxf", "link_id": "2356UTnKtRt_atVWUJCB5mBgYP6bhTuU91YCLgLd4zZQclplXKUty8YgXL5jjRlmjAbAnmAIFPb8q8JDGvvng99S903nog6k_c" } ], "error_list": [ { "bid": "77", "brand_name": "test bid", "message": "Bid not found or no relationship." } ] }
POST get_amazon_link_status Link Status API

Check whether promotion links are still trackable by link_id.

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_link_status
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "link_ids": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c" }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": [ { "link_id": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c", "active": true, "asin": "B0CQT26VCW", "brand_id": 90863, "link": "https://www.amazon.com/dp/B0CQT26VCW?maas=...", "country": "US", "type": "product", "uid": "" } ] }
POST get_amazon_report Amazon Report API

Order conversion / performance report for tracking links (date range, marketplace, ASINs, ad groups, order IDs).

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_report
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 100, "page": 1, "start_date": "20241201", "end_date": "20241202", "marketplace": "", "asins": "", "adGroupIds": "", "order_ids": "" }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": { "list": [ { "asin": "B0C6DHK68Q", "date": "20241202", "marketplace": "US", "currency": "USD", "estCommission": 0, "sales": 0, "quantity": 0, "conversionRate": "0.00%", "clicks": 4, "addToCarts": 0, "detailPageViews": 2, "productConversionType": "Promoted", "link": "https://www.amazon.com/dp/...", "uid": "sherry", "adGroupId": "a6e3PBLq_ayRy2ZHjkvNvuSc3HqaLxHWh7tZO1jvSwkhTmyEsUJtgQga1fQOAqndyCMTs_aBKOVU6OLQmWZeLPfEGF9URtJkGJAQEXdWdQjhj5U2Jv7PmcjWf1Wgw6UYyiGHT3Wvz_c", "order_id": "C1TIP-PJ09161555" } ] } }
POST get_latest_associates_products Associates ASIN List API

Filter and search Amazon Associates program ASINs (region, pagination).

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_latest_associates_products
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 200, "page": 1, "filter_sexual_wellness": 0, "region": "us" }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": { "list": [ { "brand_name": "cololight", "asin": "B0DT9Q7CT2", "commission": 0.15, "region": "us", "net_commission": 0.03, "start_date": "2025-10-09T10:00:00-07:00", "end_date": "2025-10-19T11:00:00-07:00", "acc_commission_rate": 0.12, "acc_start_date": "2025-08-01", "acc_end_date": "2025-12-31", "acc_budget": "10000.00", "acc_spend": "518.80", "acc_currency": "USD" } ] } }
POST get_latest_acc_products Amazon Creator Connection ASIN List API

Filter and search Amazon Creator Connection (ACC) campaign ASINs.

Endpoint
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_latest_acc_products
Request Demo
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 200, "page": 1 }
Response Demo
{ "status": { "code": 0, "msg": "success" }, "data": { "list": [ { "bid": 73237, "brand_name": "cololight", "asin": "B0CXPD7ZN9", "commission": "0.15", "start_date": "2026-03-18T00:57:18-07:00", "end_date": "2026-04-01T00:59:59-07:00", "acc_campaign_id": "amzn1.campaign.3ABT368W9RO04", "acc_commission_rate": "0.12", "acc_start_date": "2026-03-10", "acc_end_date": "2026-04-09", "acc_budget": "5000.00", "acc_spend": "0.00", "acc_currency": "USD" } ] } }
合作伙伴关系管理解决方案的行业领导者，使品牌或营销人员能够通过端到端的软件解决方案和服务释放实现全球化增长。