PartnerBoost API 文档

将您的系统与 PartnerBoost 的合作伙伴管理平台集成。借助我们的 API,您可以通过编程方式管理交易、生成报告、处理广告素材以及管理产品数据源。

品牌AI

概述

PartnerBoost的商家端技能已正式集成至OpenClaw平台。依托OpenClaw的“AI大脑+自动化运营”能力,该平台为跨境电商商家提供类AI数字员工式的运营服务。 商家只需通过自然语言指令,即可快速完成订单数据查询、绩效分析、渠道效果复盘、账单核对、合作伙伴媒体管理等操作,无需手动登录后台导出报表。这极大提升了联盟营销运营效率,实现了从人工操作到智能交互的效率升级。

指南 - OpenClaw

OpenClaw Skill 安装指引

一、获取 API Key

在开始查询前,请先准备好 PARTNERBOOST_API_KEY

  1. 主账号:登录 PartnerBoost(PB)平台,在「设置」或「API 管理」页面直接查看并复制 API Key。
  2. 子账号:联系主账号管理员,在 PB 平台内为你分配 API Key。

二、创建飞书企业应用

  1. 进入飞书开放平台:https://open.feishu.cn/app
  2. 点击创建企业自建应用,按指引完成基础创建流程。 飞书开放平台:企业自建应用,创建企业自建应用按钮
  3. 左侧菜单栏点击添加应用能力,在右侧找到机器人并点击「添加」。 飞书开放平台:添加应用能力,机器人卡片与添加按钮
  4. 左侧菜单栏点击凭证与基础信息,复制 App IDApp Secret 备用。 飞书开放平台:凭证与基础信息,应用凭证 App ID 与 App Secret

三、在阿里云创建 OpenClaw 实例

  1. 阿里云搜索「OpenClaw」,进入购买页面:https://www.aliyun.com/benefit/scene/openclaw 阿里云 OpenClaw 场景页:快速部署 OpenClaw
  2. 选择适配配置,完成购买。 阿里云轻量应用服务器:选择 OpenClaw 应用镜像与套餐并完成购买
  3. 等待实例创建完成,点击管理 OpenClaw阿里云轻量应用服务器列表:点击实例上的「管理 OpenClaw」
  4. 依次完成 OpenClaw 使用步骤 1→2→3,填入飞书应用的 App ID 和 App Secret。 阿里云 OpenClaw 应用详情:使用步骤 1→2→3 与飞书通讯配置(App ID、App Secret)

四、安装 PartnerBoost Brand Skill

  1. 打开飞书,搜索并找到已创建的 OpenClaw 应用机器人。
  2. 发送以下指令(将 PARTNERBOOST_API_KEY 替换为你的实际 Key):
    帮我安装这个技能 https://github.com/partnerboost-tech-team/partnerboost-brand 然后初始化他,我的key是 PARTNERBOOST_API_KEY
    飞书与 OpenClaw 机器人对话:发送安装指令与技能安装成功提示
  3. 等待机器人提示技能安装成功。
  4. 发送指令重启,重启 OpenClaw 使配置生效。 飞书:发送重启指令与 OpenClaw 机器人确认在线
  5. 重启完成后即可正常使用,支持查询订单、合作媒体、业绩数据等功能。

PartnerBoost OpenClaw Skill Installation Guide

Content generated by AI

1. 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

  1. Go to the Discord Developer Portal: https://discord.com/developers/applications
  2. Click "New Application", enter a name, and create it.
  3. 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).
  4. 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.
  5. Go to "General Information" and copy the Application ID (Client ID) for later use.

3. Create an OpenClaw Instance on AWS

  1. Log in to the AWS Management Console and navigate to the EC2 dashboard.
  2. 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.
  3. Deploy OpenClaw:
    • Connect to your instance via SSH and install Docker.
    • Pull and run the OpenClaw image.
  4. 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

  1. Open Discord and go to the server where your OpenClaw bot is present.
  2. 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]
  3. Wait for the bot to reply: "Skill installation successful."
  4. Send the command restart to apply the changes.
  5. Once restarted, the bot is ready. You can now query orders, affiliate partners, and performance data.

用例

用例 1:绩效评估与岗位优化

示例任务:审查过去三个月的采购订单数据,并提出订单下达的优化建议。

AI 功能:自动提取订单数据 → 分析各渠道的投资回报率 → 识别高转化率媒体 → 提供佣金调整和投放优化的建议。

用例 2:实时订单监控

示例指令:近期订单表现如何?请总结表现最佳的销售渠道。

AI 功能:汇总关键订单指标 → 标记异常订单(退款、可疑交易)→ 生成优质渠道列表。

用例 3:快速查询账单

示例指令:请查看我上个月的账单。

AI 功能:直接检索所选月份的账单 → 无需登录后台即可显示佣金详情和结算状态。

用例 4:合作伙伴媒体管理

示例指令:我目前正在与哪些推广媒体合作?

AI 功能:列出所有合作推广媒体,并清晰展示资源结构。

常见问题解答

问题1:谁可以使用 PartnerBoost Skills?

答:所有已开通 PartnerBoost 的商家用户均可启用该功能。

问题2:AI可以查询哪些数据?

A:它支持核心运营数据,例如订单数据、销量、转化率、渠道表现、账单详情以及合作伙伴媒体数据。

问题3:如何确保数据安全?

答:所有数据访问和操作均在商户授权范围内进行,符合平台安全标准,且不会泄露任何业务数据。

问题4:除了查询数据,AI还能做什么?

A:它能够自动分析数据、提供投放建议并监控异常订单。未来,它还将支持创建营销活动、选择网红以及生成营销素材等功能。

问题 5:如果配置失败或该功能不可用,该怎么办?

答:请确认您已登录 ClawHub 并正确添加了 PartnerBoost 技能。如果问题仍然存在,请联系 PartnerBoost 客服或您的客户经理。

品牌 API

身份验证

PartnerBoost API 目前支持多种不同的操作。所有请求均应以 HTTPS GET 或 POST(JSON)请求的形式发送至:

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

必填参数

  • 出价 - 您的品牌识别码
  • 代币 - 在为账户配置 API 功能时生成的唯一令牌
  • 动作 - 支持的操作之一
  • 版本 - 当前版本 1.0

必需的头文件

  • 内容类型 - application/json
  • X-PARTNERBOOST-DATE - 当前日期(UTC,协调世界时)
  • X-PARTNERBOOST-AUTHENTICATION - 计算出的身份验证哈希值

身份验证哈希

身份验证哈希是字符串的 SHA-256 哈希值,采用 64 位十六进制格式:

您的API密钥;API操作值;当前日期(UTC格式);您的API密钥
示例

对于以下数值:

  • API 操作:order/new
  • 令牌:a25fb1225425ae360ec2922286e7bd01
  • API密钥:65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c
  • UTC 日期:2022年1月7日 星期五 07:21:16 GMT
  • 字符串转哈希值:a25fb1225425ae360ec2922286e7bd01;order/new;2022年1月7日 星期五 07:21:16 GMT;65906f8ecdaf1147bca07dbebf9d29656317a2913783b6ac6f08c6d5713dca5c

修正 HTTP 头部

  • X-PARTNERBOOST-DATE:2022年1月7日 星期五 07:21:16 GMT
  • X-PARTNERBOOST-AUTHENTICATION:c0603ea2f4bd66eaac5e6fbbd2093ea6426d7e13e0a8cc4f5550368f55f7e64a

交易 API

POST 订单/新建 创建新交易
关键 职位 示例 必填 类型
订单号 您的专属订单号 201000000001 字符串
pbtid PartnerBoost 点击跟踪代码 x_xxxxx 字符串
is_new_customer 是该品牌的新客户吗 false bool
uid 品牌中的用户身份 453215 字符串
货币 订单货币 美元 字符串
trans_time 订单处理时间 2022年1月20日 星期四 05:27:30 GMT 字符串
金额 实际订单金额 111.55 双倍
数量 产品数量 1 int
备注 任何消息 字符串
优惠码 以逗号分隔的优惠码列表 ZVKD234,ZVKA111 字符串
skus SKU列表(订单包含SKU时必填) 数组 数组
申请演示
{ "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 } ] }
响应演示
{ "code": 0, "data": "210120052732256X22", "msg": "success" }
POST 撤销订单/作废 撤销交易
关键 职位 示例 必填 类型
订单号 您的专属订单号 201000000001 字符串
申请演示
{ "order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234" }
响应演示
{ "code": 0, "data": "", "msg": "success" }
发布 生效交易
关键 职位 示例 必填 类型
订单号 您的专属订单号 201000000001 字符串
申请演示
{ "order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234" }
响应演示
{ "code": 0, "data": "", "msg": "success" }
帖子 订单/奖励 向发布者发放奖金
关键 职位 示例 必填 类型
medium_id 出版商信息 LDC000123 字符串
货币 订单货币 美元 字符串
trans_time 订单处理时间 2022年1月20日 星期四 05:27:30 GMT 字符串
佣金 出版商佣金 11.15 双倍
备注 任何消息 字符串
申请演示
{ "medium_id": "LDC0012346", "currency": "CNY", "trans_time": "Thu, 20 Jan 2022 05:27:30 GMT", "commission": 416.4 }
响应演示
{ "code": 0, "data": "210120052732256X22", "msg": "success" }

报告 API

POST 报告/点击列表 点击列表
关键 职位 示例 必填 类型
开始时间 开始时间戳 1650351153 int
结束时间 结束时间戳 1670351153 int
首先 第一 0 int
页面大小 页面大小为 20 至 100 20 int
发布者ID 发布者 ID 字符串
频道ID 频道ID 字符串
申请演示
{ "first": 720078 }
响应演示
{ "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 报告/点击详情 点击详情
关键 职位 示例 必填 类型
id 转账ID(id和pbtid中至少需填写一项) 720078 int
pbtid 来自着陆页 URL 的追踪标识符(id 或 pbtid 其中之一为必填项) pb_xxxx 字符串
申请演示
{ "id": 720112 }
响应演示
{ "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 报告/订单列表 订单列表
关键 职位 示例 必填 类型
开始时间 交易时间戳 1650351153 int
结束时间 交易时间戳 1670351153 int
页码 页码 1 int
页面大小 页面大小为 20 至 100 20 int
sort_dir enum(降序, 升序),默认值为降序 desc enum
按列排序 enum(交易ID, 佣金, 金额) transid enum
状态 enum(new, void, effective) enum
类型 交易类型 enum
申请演示
{ "status": "effective" }
响应演示
{ "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 报告/交易列表 交易列表
关键 职位 示例 必填 类型
上限 每页条数(最大 200,默认 100) 100 int
光标 分页光标 1 字符串
开始日期 开始日期(YYYYMMDD) 20241101 字符串
结束日期 结束日期(YYYYMMDD) 20241101 字符串
订单状态 订单状态 new、void、mixed、locked、paid 字符串
sku_status SKU/ASIN 状态 新、无效、已锁定、已支付 字符串
交易类型 交易类型 额外奖励, 手动添加, 普通 字符串
发布者ID 发布者 ID 字符串
group_id 分配给发布者的组 ID 323 字符串
申请演示
{ "limit": 100, "cursor": "1", "start_date": "20241101", "end_date": "20241130", "order_status": "locked" }
响应演示
{ "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 } }

创意 API

POST 创意/列表 创意列表
关键 职位 示例 必填 类型
类型 类型 图片/文字/优惠券 字符串
状态 状态 已安排/正在进行/已过期 数组
隐私 权限 公共/私有 数组
关键词 关键词 测试 字符串
页码 页码 1 int
页面大小 页面大小 10 int
申请演示
{ "type": "IMAGE", "status": ["Active"], "privacy": ["PUBLIC"], "keyword": "test", "page_num": 1, "page_size": 10 }
响应演示
{ "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" }
发布 创意/创作 上传创意
关键 职位 示例 必填 类型
类型 类型 图片/文字/优惠券 字符串
开始时间 开始时间 1680241332 字符串
结束时间 末日 1682574132 字符串
链接 链接(当 type == TEXT 时必填) https://www.example.com 字符串
内容 内容(当 type == TEXT 时为必填项) 测试 字符串
图片 图片(当 type == IMAGE 时必填) 数组 数组
标题 职位 测试 字符串
隐私 隐私 公共/私有 字符串
申请演示
{ "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" }
响应演示
{ "code": 0, "data": [ 132508 ], "msg": "success" }
发布 发布/修改 编辑创意
关键 职位 示例 必填 类型
id ID 132505 字符串
标题 职位 测试 字符串
开始时间 开始时间 1680241332 字符串
结束时间 末日 1682574132 字符串
隐私 隐私 公共/私有 字符串
申请演示
{ "id": "132505", "title": "test", "category": "cate", "privacy": "PUBLIC", "start_time": "1680241332", "end_time": "1682574132" }
响应演示
{ "code": 0, "data": null, "msg": "success" }

数据源 API

POST datafeed/get_info 获取数据源信息
申请演示
{}
响应演示
{ "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 数据源/更新设置 更新数据源设置
关键 职位 示例 必填 类型
fetch_period 获取周期(从不、每日、每周、每月) 每日 字符串
fetch_url 获取 URL http://www.yousite.com/datafeed.xml 字符串
申请演示
{ "fetch_period": "DAILY", "fetch_url": "http://www.yousite.com/datafeed.xml" }
响应演示
{ "code": 0, "data": null, "msg": "success" }
POST datafeed/update_product 更新或添加产品
关键 职位 示例 必填 类型
名称 产品名称 产品名称 字符串
url 产品网址 http://www.yousite.com/product/1 字符串
图片 产品图片 http://www.yousite.com/product/1.jpg 字符串
sku 产品SKU(唯一编号) 商品编号 字符串
价格 产品价格 100 数字
货币 货币代码(ISO 4217) 美元 字符串
描述 产品描述 产品描述 字符串
分类 产品类别 分类 字符串
原价 产品原价 100 数字
品牌 产品品牌 品牌 字符串
gtin 全球贸易项目编号 9783161484100 字符串
mpn 制造商零件号 CR2032 字符串
可用性 产品供应情况 有货 字符串
申请演示
{ "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" }
响应演示
{ "code": 0, "data": "Added", "msg": "success" }

发布商 API

发布 出版商/书目 出版商列表
关键 职位 示例 必填 类型
发布者ID 发布者 ID 9527 int
频道ID 频道ID 9527 int
状态 状态 加入 字符串
申请演示
{ "publisher_id": 9527, "apply_status": "joined", "channel_id": 9527 }
响应演示
{ "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": [] } ] }
发布 发布者/维护 发布者维护
关键 职位 示例 必填 类型
用户ID 用户 ID(用户 ID 和站点 ID 中至少需填写一项) 40828 字符串
site_ids 站点 ID(userId 和 site_ids 中至少需填写一项) 40828 字符串
邮件ID 邮件ID 40828 字符串
自动批准 自动批准 1 int
状态 状态(采纳/解封/终止/拒绝) 采用 字符串
申请演示
{ "site_ids": "40828", "auto_approve": 1, "status": "adopt" }
响应演示
{ "code": 0, "data": null, "msg": "success" }
发布商 API

身份验证

应向以下端点发送发布商 API 请求:

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

HTTP 请求方法

  • POST application/x-www-form-urlencoded
  • POST application/json
  • 获取

返回格式

  • JSON(默认)
  • XML

必填参数

  • 代币 - 您的频道 API 密钥(可在发布者仪表盘中找到)

每个频道都有一个唯一的 API 令牌。您可以在发布者仪表盘的“工具”>“API”下找到您的令牌。

常见结果代码

编码 描述
0 成功
1000 该出版商不存在
1001 令牌无效
1002 呼叫频率过高
1003 缺少必需参数或格式不正确
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_type": "DTC", "relationship": "Joined" }
响应演示
{ "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" } ] }

交易

POST POST事务 获取交易列表

查看详细交易记录、佣金状态等更多信息。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d
开始日期 交易期开始。交易期或验证期中至少需填写一项。 2024年1月1日
结束日期 交易期结束 2024年1月31日
验证起始日期 验证期开始。交易期或验证期中至少需填写一项。 2024年1月1日
有效期截止日期 验证期结束 2024年1月31日

可选参数

关键 描述 示例
类型 返回格式:json(默认)或 xml json
订单编号 订单编号 ORD123456
状态 委托状态:待处理、已批准、已拒绝、正常、全部 已批准
uid 您的自定义跟踪变量 tracking123
品牌ID 品牌标识 66303
mcid 该品牌的唯一标识符 ulike0
页面 当前页面索引 1
上限 每页交易条数(最多 2000 条) 100

返回参数

关键 描述
频道ID 频道ID
总页数 总页数
total_trans 销售交易总数
品牌ID 品牌标识
mcid 该品牌的唯一标识符
商家名称 品牌名称
订单编号 订单编号
订单时间 交易时间
销售金额 销售金额
sale_comm 销售佣金
状态 委托状态
uid 您的自定义跟踪变量
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "begin_date": "2024-01-01", "end_date": "2024-01-31", "status": "Approved" }
响应演示
{ "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" } ] } }

点击“举报”

发布 转移 获取点击报告

提取详细的点击日志。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d
开始日期 开始日期和时间 2024-01-01 00:00:00
结束日期 结束日期和时间 2024年1月1日 01:00:00
速率限制

开始和结束日期参数的范围不得超过一小时。每分钟最多允许10次请求。

返回参数

关键 描述
频道ID 频道ID
总页数 总页数
总件数 按项目分类的交易总额
品牌ID 品牌标识
mcid 该品牌的唯一标识符
商家名称 品牌名称
uid 您的自定义跟踪变量
点击时间 客户点击您链接的时间(UTC+8)
点击_ref 一个唯一的交易参考标识
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "begin_date": "2024-01-01 00:00:00", "end_date": "2024-01-01 01:00:00" }
响应演示
{ "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": "" } ] } }

委员会

POST merchant_commission 佣金验证 API

按品牌显示每月已批准的佣金明细。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d
开始日期 开始日期 2024年1月1日
结束日期 结束日期 2024年1月31日

返回参数

关键 描述
品牌ID 品牌标识
mcid 该品牌的唯一标识符
sale_comm 销售佣金
结算日期 佣金获批且可提现的日期
产生该金额的时间段
结算ID 唯一标识符表示商户已批准佣金
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "begin_date": "2024-01-01", "end_date": "2024-01-31" }
响应演示
{ "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 佣金详情 API

使用结算 ID 按品牌检索各笔交易的佣金明细。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d
结算ID 唯一标识符表示商户已批准佣金 12345

返回参数

关键 描述
品牌ID 品牌标识
mcid 该品牌的唯一标识符
商家名称 品牌名称
订单编号 订单编号
订单时间 交易时间
销售金额 销售金额
sale_comm 销售佣金
状态 委托状态
uid 您的自定义跟踪变量
prod_id 产品编号
订购单位 订购单位 数量
结算ID 唯一标识符表示已批准的佣金
验证日期 交易验证日期
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "settlement_id": "12345" }
响应演示
{ "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 付款摘要 API

显示您的付款记录。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d
payment_id 付款ID(payment_id 或 paid_date_begin 和 paid_date_end 为必填项) 12345
付款起始日期 工资发放日期起始日(YYYY-MM-DD) 2024年1月1日
支付截止日期 付款日期(年-月-日) 2024年1月31日

返回参数

关键 描述
payment_id 在付款记录中找到的付款ID
请求日期 付款创建日期
付款日期 标记为已付款的日期
付款方式 付款方式
付款详情 账户信息
发票 发票信息
金额 付款金额
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "paid_date_begin": "2024-01-01", "paid_date_end": "2024-01-31" }
响应演示
{ "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 支付详情 API

显示您的详细付款信息。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d
payment_id 付款ID(payment_id 或 paid_date_begin 和 paid_date_end 为必填项) 12345
付款起始日期 工资发放日期起始日(YYYY-MM-DD) 2024年1月1日
支付截止日期 付款日期(年-月-日) 2024年1月31日

返回参数

关键 描述
品牌ID 品牌标识
mcid 该品牌的唯一标识符
金额 佣金金额或奖金金额
验证日期 佣金获批日期
类型 报酬形式可以是佣金或奖金
产生该金额的时间段
结算ID 唯一标识符表示已批准的佣金
商家名称 商家名称
payment_id 在付款记录中找到的付款ID
付款日期 标记为已付款的日期
sign_id 记录唯一标识符
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "payment_id": "3949" }
响应演示
{ "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" } ] }

变现

POST monetization_api 变现 API

查看品牌详情状态,并获取推广链接以实现流量变现。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d

可选参数

关键 描述 示例
类型 返回格式:json(默认)或 xml json
品牌类型 品牌类型:TikTok、DTC、亚马逊、沃尔玛、间接渠道 DTC
审批类型 按审批类型筛选:自动、手动 自动
优惠类型 按品牌定价模式筛选:CPS、CPA、CPC、CPL、CPX、CPM CPS
关系 按当前品牌关系筛选:已加入、待处理、已拒绝、无关系 已加入
分类 按品牌分类筛选 服装
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_type": "DTC", "relationship": "Joined" }
响应演示
{ "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" } ] }

优惠券

POST coupon_list 优惠券 API

获取各大品牌的可用优惠券和优惠活动。

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

必填参数

关键 描述 示例
代币 优惠券代币 79e33f8dac5a0be8579018760cff4cc227fb888d

可选参数

关键 描述 示例
品牌类型 3种品牌类型:D2C、亚马逊、间接渠道 D2C
品牌ID 品牌标识 66303
mcid 该品牌的唯一标识符 ulike0
曲目 跟踪链接中的跟踪代码 track123
类型 优惠券分为两种类型:优惠券或优惠活动 优惠券
国家 可使用该优惠券的国家 美国
来源类别 提供优惠券的商家类别 服装
级别 1-4级,1级为最高级 1
lang 优惠券的语言 en
每页 每页显示条数(默认 50,最多 2000) 100
页面 当前页码索引(从1开始) 1
创建时间 创建时间(YYYY-MM-DD) 2024年1月1日
更新于 更新时间(YYYY-MM-DD) 2024年1月1日

返回参数

关键 描述
creative_id 创意ID
品牌ID 品牌标识
限制 优惠券限制
关键词 关键词
图片 优惠券图片
缩略图 缩略图
smart_url 智能链接
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_id": "66303", "per_page": 100, "page": 1 }
响应演示
{ "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" } ] }

数据源

POST 列表 数据源列表 API

从品牌方获取产品数据源。

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

必填参数

关键 描述 示例
代币 您的频道 API 令牌 79e33f8dac5a0be8579018760cff4cc227fb888d

可选参数

关键 描述 示例
类型 返回格式:json(默认)或 xml json
品牌类型 品牌类型:TikTok、DTC、沃尔玛 DTC
品牌ID 品牌标识 66303
mcid 该品牌的唯一标识符 ulike0
页面 当前页面索引 1
上限 每页显示的产品数量(最多 100 件) 50
关键词 关键词 衬衫
价格范围 “0-75”、“75-150”、“150-300”、“300-500”、“500-1000”或“1000+”中的一个 75-150
min_discount 75、50、25、10中的一个 25

返回参数

关键 描述
名称 产品名称
描述 产品描述
品牌ID 品牌标识
mcid 该品牌的唯一标识符
商家名称 销售此产品的商家名称
url 原始产品链接
图片 产品图片的链接
sku 该产品的货号
分类 产品类别
价格 该产品的当前价格
跟踪链接 联盟营销追踪链接
跟踪链接_短链接 简短的联盟营销追踪链接
tracking_url_smart 智能联盟营销追踪链接
更新于 最后更新时间
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "brand_type": "DTC", "limit": 50, "page": 1 }
响应演示
{ "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" } ] }

亚马逊

亚马逊出版商 API 基础 URL: https://amazon-service.partnerboost.com/amazon_api. 以下所有端点均使用 POST 包含 JSON 请求体 application/json.

POST 获取 FBA 商品 获取产品 API

根据条件(分页、国家、品牌、ASIN、促销活动等)筛选和搜索亚马逊商品。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_products
申请演示
{ "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 }
响应演示
{ "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 获取 FBA 商品链接 获取产品链接(产品 ID)API

根据 Get Products API 返回的产品 ID 生成跟踪链接。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_products_link
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "product_ids": "007d030d256e3e35774d65822f89c778", "uid": "123" }
响应演示
{ "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 获取商品链接(ASIN)API

使用 ASIN 和销售平台生成产品追踪链接。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_link_by_asin
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "asins": "B0CQT26VCW", "country_code": "US", "uid": "", "return_partnerboost_link": 0 }
响应演示
{ "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 获取已加入亚马逊的品牌 获取合作品牌 API

列出您合作的亚马逊品牌(分页显示)。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_joined_brands
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "bids": "90863", "page_size": 20, "page": 1 }
响应演示
{ "status": { "code": 0, "msg": "success" }, "data": { "list": [ { "bid": "90863", "brand_name": "Midea_US", "support_storefront_link": "yes" } ], "hasMore": false } }
POST 获取 FBA 品牌链接 获取商店链接 API

根据品牌 ID(出价)生成店铺追踪链接。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_fba_brand_link
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "bids": "90863", "uid": "zxf" }
响应演示
{ "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 获取亚马逊链接状态 链接状态 API

请检查促销链接是否仍可通过 link_id 进行追踪。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_link_status
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "link_ids": "2ff9hHMP1uL7XgpmaCERzIlQ1gFQhwaNuCOb_bPEa6NfGIuU7Bbf9zjFW7tyPCyNUCPDH_bvW16vdcA8fMoxkYd7xpkgc9UhIkEXU_c" }
响应演示
{ "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 获取亚马逊报告 亚马逊报告 API

订单转化/效果报告(用于追踪链接,包含日期范围、电商平台、ASIN、广告组、订单ID)。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_amazon_report
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 100, "page": 1, "start_date": "20241201", "end_date": "20241202", "marketplace": "", "asins": "", "adGroupIds": "", "order_ids": "" }
响应演示
{ "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 获取最新关联商品 关联 ASIN 列表 API

筛选和搜索亚马逊联盟计划的ASIN(按地区、分页)。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_latest_associates_products
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 200, "page": 1, "filter_sexual_wellness": 0, "region": "us" }
响应演示
{ "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 获取最新账户产品 亚马逊创作者连接 ASIN 列表 API

筛选并搜索亚马逊创作者连接(ACC)营销活动的ASIN。

端点
https://amazon-service.partnerboost.com/amazon_api/api/datafeed/get_latest_acc_products
申请演示
{ "token": "79e33f8dac5a0be8579018760cff4cc227fb888d", "page_size": 200, "page": 1 }
响应演示
{ "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" } ] } }
合作伙伴关系管理解决方案的行业领导者,使品牌或营销人员能够通过端到端的软件解决方案和服务释放实现全球化增长。
亚马逊及所有相关标识均为亚马逊公司(Amazon.com, Inc.)或其关联公司的商标。