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.
Overview
PartnerBoost merchant-side Skills have been officially integrated with the OpenClaw platform. Leveraging OpenClaw’s “AI brain + automated operation” capabilities, it provides cross-border e-commerce merchants with AI digital employee-style operational services. Merchants can quickly complete order data queries, performance analysis, channel effect review, bill checking, partner media management and other operations simply through natural language instructions, without manually logging into the backend to export reports. This greatly improves the efficiency of affiliate marketing operations and achieves an efficiency upgrade from manual operation to intelligent interaction.
Guide - OpenClaw
OpenClaw Skill 安装指引
一、获取 API Key
在开始查询前,请先准备好 PARTNERBOOST_API_KEY:
- 主账号:登录 PartnerBoost(PB)平台,在「设置」或「API 管理」页面直接查看并复制 API Key。
- 子账号:联系主账号管理员,在 PB 平台内为你分配 API Key。
二、创建飞书企业应用
- 进入飞书开放平台:https://open.feishu.cn/app
-
点击创建企业自建应用,按指引完成基础创建流程。
-
左侧菜单栏点击添加应用能力,在右侧找到机器人并点击「添加」。
-
左侧菜单栏点击凭证与基础信息,复制 App ID 及 App Secret 备用。
三、在阿里云创建 OpenClaw 实例
-
阿里云搜索「OpenClaw」,进入购买页面:https://www.aliyun.com/benefit/scene/openclaw
-
选择适配配置,完成购买。
-
等待实例创建完成,点击管理 OpenClaw。
-
依次完成 OpenClaw 使用步骤 1→2→3,填入飞书应用的 App ID 和 App Secret。
四、安装 PartnerBoost Brand Skill
- 打开飞书,搜索并找到已创建的 OpenClaw 应用机器人。
-
发送以下指令(将
PARTNERBOOST_API_KEY替换为你的实际 Key):帮我安装这个技能 https://github.com/partnerboost-tech-team/partnerboost-brand 然后初始化他,我的key是 PARTNERBOOST_API_KEY
- 等待机器人提示技能安装成功。
-
发送指令重启,重启 OpenClaw 使配置生效。
- 重启完成后即可正常使用,支持查询订单、合作媒体、业绩数据等功能。
PartnerBoost OpenClaw Skill Installation Guide
Content generated by AI1. Obtain Your API Key
Before starting, ensure you have your PARTNERBOOST_API_KEY ready:
- Primary Account: Log in to the PartnerBoost (PB) platform. Go to the "Settings" or "API Management" page to view and copy your API Key.
- Sub-Account: Contact your primary account administrator to have an API Key assigned to you within the PB platform.
2. Create a Discord Bot
- Go to the Discord Developer Portal: https://discord.com/developers/applications
- Click "New Application", enter a name, and create it.
-
Navigate to the "Bot" tab in the left sidebar:
- Click "Reset Token" to generate your Bot Token. (Copy and save it immediately; it will not be shown again).
- Under the "Privileged Gateway Intents" section, toggle ON the
MESSAGE CONTENT INTENT(This is required for the bot to read your commands).
-
Navigate to "OAuth2" → "URL Generator":
- Scopes: Select
bot. - Bot Permissions: Select
Administrator(or specific messaging permissions). - Copy the generated URL, paste it into your browser, and invite the bot to your Discord server.
- Scopes: Select
- Go to "General Information" and copy the Application ID (Client ID) for later use.
3. Create an OpenClaw Instance on AWS
- Log in to the AWS Management Console and navigate to the EC2 dashboard.
-
Launch Instance:
- Name:
OpenClaw-Server. - OS (AMI): Select
Ubuntu 22.04 LTS(Recommended). - Instance Type: Select
t3.medium(2 vCPU, 4GB RAM) or higher. - Security Group: Ensure ports TCP 80, 443, and the specific OpenClaw WebUI port are open.
- Name:
-
Deploy OpenClaw:
- Connect to your instance via SSH and install Docker.
- Pull and run the OpenClaw image.
-
Initialization:
- Access the OpenClaw WebUI via your instance's Public IP in a browser.
- Enter your Discord Bot Token and Application ID during the setup steps.
- Complete the basic configuration and dashboard initialization.
4. Install PartnerBoost Brand Skill
- Open Discord and go to the server where your OpenClaw bot is present.
-
Send the following command to the bot (Replace
[YOUR_API_KEY]with your actual key):Command:
Please install this skill https://github.com/partnerboost-tech-team/partnerboost-brand and initialize it. My key is [YOUR_API_KEY] - Wait for the bot to reply: "Skill installation successful."
- Send the command
restartto apply the changes. - Once restarted, the bot is ready. You can now query orders, affiliate partners, and performance data.
Use Cases
Use Case 1: Performance Review & Placement Optimization
Sample instruction: Review PB order data from the past three months and provide placement optimization suggestions.
AI function: Automatically pulls order data → analyzes ROI across channels → identifies high-conversion media → provides recommendations for commission adjustments and placement optimization.
Use Case 2: Real-time Order Monitoring
Sample instruction: How are recent orders performing? Summarize the top-performing channels.
AI function: Compiles key order metrics → flags abnormal orders (refunds, suspicious transactions) → generates a list of high-quality channels.
Use Case 3: Quick Bill Inquiry
Sample instruction: Check my bill from last month.
AI function: Directly retrieves bills for the selected month → displays commission details and settlement status without logging into the backend.
Use Case 4: Partner Media Management
Sample instruction: Which promotional media am I currently partnering with?
AI function: Lists all partnered promotional media and clearly displays the resource structure.
FAQ
Q1: Who can use PartnerBoost Skills?
A: All merchant users who have onboarded PartnerBoost can enable it.
Q2: What data can the AI query?
A: It supports core operational data such as order data, sales volume, conversion rate, channel performance, billing details, and partner media.
Q3: How is data security ensured?
A: All data access and operations are performed within the scope of merchant authorization, in compliance with platform security standards, and no business data will be disclosed.
Q4: What else can the AI do besides querying data?
A: It can automatically analyze data, provide placement suggestions, and monitor abnormal orders. In the future, it will support creating campaigns, selecting influencers, generating marketing materials, and more.
Q5: What if configuration fails or the feature is unavailable?
A: Please confirm that you have logged in to ClawHub and added PartnerBoost Skills correctly. If the issue persists, contact PartnerBoost customer service or your account manager.
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:
Required Parameters
bid- Your brand ID numbertoken- Unique token received when account is set up for API useaction- One of the supported actionsversion- Currently 1.0
Required Headers
Content-Type- application/jsonX-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:
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
| Key | Title | 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 |
| Key | Title | Example | Required | Type |
|---|---|---|---|---|
order_number |
Your unique order number | 201000000001 | Yes | string |
| Key | Title | Example | Required | Type |
|---|---|---|---|---|
order_number |
Your unique order number | 201000000001 | Yes | string |
| Key | Title | 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 |
Report API
| Key | Title | 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 |
| Key | Title | 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 |
| Key | Title | 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 |
| Key | Title | 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 |
Creative API
| Key | Title | 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 |
| Key | Title | 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 |
Title | test | No | string |
privacy |
Privacy | PUBLIC/PRIVATE | No | string |
| Key | Title | Example | Required | Type |
|---|---|---|---|---|
id |
ID | 132505 | Yes | string |
title |
Title | test | No | string |
start_time |
Start Time | 1680241332 | No | string |
end_time |
End Time | 1682574132 | No | string |
privacy |
Privacy | PUBLIC/PRIVATE | No | string |
Datafeed API
| Key | Title | 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 |
| Key | Title | 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 | 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 |
Publisher API
| Key | Title | Example | Required | Type |
|---|---|---|---|---|
publisher_id |
Publisher ID | 9527 | No | int |
channel_id |
Channel ID | 9527 | No | int |
status |
Status | joined | No | string |
| Key | Title | 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 |
Authentication
Publisher API requests should be made to the following endpoint:
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)
Each channel has its own unique API token. You can find your tokens in the Publisher Dashboard under Tools > API.
Common Result Codes
| Code | Description |
|---|---|
0 |
Success |
1000 |
Publisher does not exist |
1001 |
Invalid token |
1002 |
Call frequency too high |
1003 |
Missing required parameters or incorrect format |
Transaction
Pull detailed transactions, commission status and many more.
Required Parameters
| Key | Description | 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 | Description | 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 | Description |
|---|---|
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 |
Click Report
Pull detailed click log.
Required Parameters
| Key | Description | 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 |
The span of start and end date parameter values cannot exceed one hour. Maximum 10 requests per minute.
Return Parameters
| Key | Description |
|---|---|
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 |
Commission
Shows approved commission breakdown by brand on a monthly basis.
Required Parameters
| Key | Description | Example |
|---|---|---|
token |
Your channel API token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
begin_date |
Start date | 2024-01-01 |
end_date |
End date | 2024-01-31 |
Return Parameters
| Key | Description |
|---|---|
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 |
Use settlement ID to retrieve commission breakdown by transactions per brand.
Required Parameters
| Key | Description | Example |
|---|---|---|
token |
Your channel API token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
settlement_id |
Unique ID indicates approved commission by merchant | 12345 |
Return Parameters
| Key | Description |
|---|---|
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 |
Payment
Shows your payment history.
Required Parameters
| Key | Description | 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 | Description |
|---|---|
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 |
Shows your detailed payment.
Required Parameters
| Key | Description | 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 | Description |
|---|---|
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 |
Monetization
Check brand details status and acquire campaign links to monetize your traffic.
Required Parameters
| Key | Description | Example |
|---|---|---|
token |
Your channel API token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Optional Parameters
| Key | Description | 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 |
Coupon
Get available coupons and deals from brands.
Required Parameters
| Key | Description | Example |
|---|---|---|
token |
Coupon Token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Optional Parameters
| Key | Description | 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 | US |
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 | Description |
|---|---|
creative_id |
Creative ID |
brand_id |
Brand ID |
restrictions |
Coupon restrictions |
keywords |
Keywords |
image |
Coupon image |
thumbnail |
Thumbnail image |
smart_url |
Smart URL |
Datafeed
Get product datafeed from brands.
Required Parameters
| Key | Description | Example |
|---|---|---|
token |
Your channel API token | 79e33f8dac5a0be8579018760cff4cc227fb888d |
Optional Parameters
| Key | Description | 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 | Description |
|---|---|
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 |
Amazon
Amazon Publisher API base URL: https://amazon-service.partnerboost.com/amazon_api. All endpoints below use POST with JSON body application/json.
Filter and search Amazon products by criteria (pagination, country, brand, ASINs, promos, etc.).
Generate tracking links from product IDs returned by Get Products API.
Generate product tracking links using ASINs and marketplace.
List Amazon brands you are partnered with (paginated).
Generate storefront tracking links from brand IDs (bids).
Check whether promotion links are still trackable by link_id.
Order conversion / performance report for tracking links (date range, marketplace, ASINs, ad groups, order IDs).
Filter and search Amazon Associates program ASINs (region, pagination).
Filter and search Amazon Creator Connection (ACC) campaign ASINs.
