PartnerBoost API ドキュメント
貴社のシステムをPartnerBoostのパートナーシップ管理プラットフォームと連携させましょう。当社のAPIを利用すれば、取引の管理、レポートの作成、クリエイティブの処理、および商品データフィードの管理をプログラム的に行うことができます。
Brand AI
概要
PartnerBoostのマーチャント向け機能が、OpenClawプラットフォームに正式に統合されました。OpenClawの「AIブレイン＋自動化運用」機能を活用し、越境EC事業者に対して、AIデジタル従業員のような運用サービスを提供します。 加盟店は、バックエンドに手動でログインしてレポートをエクスポートすることなく、自然言語による指示だけで、注文データの照会、パフォーマンス分析、チャネル効果の検証、請求書の確認、パートナーメディアの管理などの業務を迅速に完了できます。これにより、アフィリエイトマーケティング業務の効率が大幅に向上し、手動操作からインテリジェントなインタラクションへの効率化を実現します。
ガイド - 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.
ユースケース
ユースケース 1：業績評価と配置の最適化
指示例：過去3か月分のPB注文データを精査し、発注の最適化に関する提案を行ってください。
AI機能：注文データを自動的に取得 → チャネルごとのROIを分析 → コンバージョン率の高いメディアを特定 → 手数料の調整や掲載位置の最適化に関する提案を行う。
ユースケース 2：注文のリアルタイム監視
指示例：最近の注文の業績はどのような状況ですか？ 業績が最も良い販売チャネルをまとめてください。
AI機能：主要な注文指標を分析 → 異常な注文（返金、不審な取引）を特定 → 質の高い販売チャネルのリストを作成。
ユースケース 3：請求書の簡易照会
指示例：先月の請求書を確認してください。
AI機能：選択した月の請求書を直接取得 → バックエンドにログインすることなく、手数料の詳細や決済状況を確認できます。
ユースケース 4：パートナーメディアの管理
指示例：現在、どのプロモーション媒体と提携していますか？
AI機能：提携しているすべてのプロモーション媒体を一覧表示し、リソース構成を明確に表示します。
よくある質問
Q1: PartnerBoost Skillsは誰が利用できますか？
A: PartnerBoostを導入済みのすべての加盟店ユーザーは、この機能を有効にすることができます。
Q2: AIはどのようなデータを照会できますか？
A: 注文データ、販売数量、コンバージョン率、チャネル別実績、請求明細、パートナーメディアなど、業務の中核となるデータをサポートしています。
Q3: データのセキュリティはどのように確保されていますか？
A: すべてのデータへのアクセスおよび操作は、加盟店による承認の範囲内で、プラットフォームのセキュリティ基準に準拠して行われ、業務データが開示されることはありません。
Q4: データの検索以外に、AIにはどのようなことができるのでしょうか？
A: データの自動分析、広告掲載位置の提案、異常な注文の監視が可能です。将来的には、キャンペーンの作成、インフルエンサーの選定、マーケティング資料の作成などもサポートする予定です。
Q5: 設定に失敗した場合や、その機能が利用できない場合はどうなりますか？
A: ClawHubにログインし、PartnerBoost Skillsを正しく追加したかどうかをご確認ください。それでも問題が解決しない場合は、PartnerBoostのカスタマーサービスまたは担当アカウントマネージャーまでお問い合わせください。
ブランドAPI
認証
PartnerBoost API は現在、さまざまなアクションに対応しています。すべてのリクエストは、HTTPS GET または POST (JSON) リクエストとして、以下の URL に対して送信する必要があります：
https://app.partnerboost.com/api/brand
必須パラメータ
入札- お客様のブランドID番号トークン- API利用のためにアカウントを設定した際に発行される一意のトークンアクション- サポートされているアクションの一つバージョン- 現在のバージョンは 1.0
必須のヘッダー
コンテンツタイプ- application/jsonX-PARTNERBOOST-DATE- UTC（協定世界時）での今日の日付X-PARTNERBOOST-AUTHENTICATION- 計算された認証ハッシュ
認証ハッシュ
認証ハッシュは、以下の文字列の SHA-256 ハッシュを 64 文字の 16 進数形式で表したものです：
YourAPIToken;APIActionValue;CurrentDateInUTCFormat;YourAPISecret
例
以下の値について：
- 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
投稿
注文/新規
新しい取引を作成する
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
注文番号 |
お客様専用の注文番号 | 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 | いいえ | 文字列 |
SKU |
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"
}
POST
注文/発効
有効な取引
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
注文番号 |
お客様専用の注文番号 | 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 |
publisher_id |
パブリッシャーID | いいえ | 文字列 | |
channel_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 のいずれか1つが必要です） | 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, asc)、デフォルトは desc | desc | いいえ | enum |
sort_col |
enum(transid, commission, amount) | 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
レポート/トランザクション一覧
取引一覧
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
上限 |
1ページあたりの件数（最大200件、デフォルトは100件） | 100 | いいえ | int |
カーソル |
ページネーション用のカーソル | 1 | はい | 文字列 |
開始日 |
開始日（YYYYMMDD） | 20241101 | いいえ | 文字列 |
終了日 |
終了日（YYYYMMDD） | 20241101 | いいえ | 文字列 |
注文状況 |
注文状況 | 新規、無効、混合、ロック済み、有料 | いいえ | 文字列 |
sku_status |
SKU/ASINのステータス | 新規、無効、ロック済み、支払い済み | いいえ | 文字列 |
transaction_type |
取引の種類 | bonus, manually_added, normal | いいえ | 文字列 |
publisher_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
投稿
クリエイティブ／リスト
クリエイティブ一覧
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
タイプ |
種類 | 画像／テキスト／クーポン | はい | 文字列 |
ステータス |
ステータス | 予定中／進行中／期限切れ | いいえ | 配列 |
プライバシー |
許可 | 公的／民間 | いいえ | 配列 |
キーワード |
キーワード | テスト | いいえ | 文字列 |
page_num |
ページ番号 | 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
datafeed/update_setting
データフィード設定の更新
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
取得期間 |
取得期間（NEVER、DAILY、WEEKLY、MONTH） | デイリー | はい | 文字列 |
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 |
商品のURL | http://www.yousite.com/product/1 | はい | 文字列 |
画像 |
商品画像 | http://www.yousite.com/product/1.jpg | はい | 文字列 |
SKU |
商品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
投稿
出版社／リスト
出版社一覧
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
publisher_id |
パブリッシャーID | 9527 | いいえ | int |
channel_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": []
}
]
}
投稿
発行者／メンテナンス
発行者・保守
| キー | タイトル | 例 | 必須 | 種類 |
|---|---|---|---|---|
userId |
ユーザーID（userId または site_ids のいずれかが必要です） | 40828 | はい | 文字列 |
サイトID |
サイトID（userId または site_ids のいずれか1つが必要です） | 40828 | はい | 文字列 |
mail_id |
メールID | 40828 | いいえ | 文字列 |
auto_approve |
自動承認 | 1 | いいえ | int |
ステータス |
ステータス（採用／ブロック解除／終了／却下） | 採用する | はい | 文字列 |
デモを申し込む
{
"site_ids": "40828",
"auto_approve": 1,
"status": "adopt"
}
レスポンスデモ
{
"code": 0,
"data": null,
"msg": "success"
}
パブリッシャーAPI
認証
Publisher API のリクエストは、以下のエンドポイントに対して送信してください：
https://app.partnerboost.com/api.php?mod=medium&op={action}
HTTPリクエストメソッド
- POST application/x-www-form-urlencoded
- POST application/json
- GET
返却形式
- JSON（デフォルト）
- XML
必須パラメータ
トークン- チャンネルのAPIトークン（パブリッシャーダッシュボードで確認できます）
注記
各チャンネルには固有のAPIトークンがあります。トークンは、パブリッシャーダッシュボードの「ツール」＞「API」から確認できます。
一般的な結果コード
| コード | 説明 |
|---|---|
0 |
成功 |
1000 |
「Publisher」は存在しません |
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
トランザクション
トランザクション一覧の取得
詳細な取引履歴や手数料の状況など、さまざまな情報を確認できます。
エンドポイント
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 |
order_id |
注文ID | ORD123456 |
ステータス |
依頼状況：保留中、承認済み、却下、通常、すべて | 承認済み |
uid |
ユーザー固有のトラッキング変数 | tracking123 |
brand_id |
ブランドID | 66303 |
mcid |
ブランド固有の識別子 | ulike0 |
ページ |
現在のページの目次 | 1 |
上限 |
1ページあたりの取引件数（最大2000件） | 100 |
戻り値
| キー | 説明 |
|---|---|
channel_id |
チャンネルID |
total_page |
総ページ数 |
total_trans |
販売取引の総件数 |
brand_id |
ブランドID |
mcid |
ブランド固有の識別子 |
merchant_name |
ブランド名 |
order_id |
注文ID |
注文日時 |
取引時間 |
sale_amount |
販売額 |
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年1月1日 00:00:00 |
終了日 |
終了日時 | 2024年1月1日 01:00:00 |
レート制限
開始日と終了日のパラメータ値の範囲は、1時間を超えてはなりません。1分あたりのリクエスト数は最大10件です。
戻り値
| キー | 説明 |
|---|---|
channel_id |
チャンネルID |
total_page |
総ページ数 |
total_items |
品目別の取引総数 |
brand_id |
ブランドID |
mcid |
ブランド固有の識別子 |
merchant_name |
ブランド名 |
uid |
ユーザー固有のトラッキング変数 |
クリック日時 |
お客様がリンクをクリックした時刻（UTC+8） |
click_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日 |
戻り値
| キー | 説明 |
|---|---|
brand_id |
ブランドID |
mcid |
ブランド固有の識別子 |
sale_comm |
販売手数料 |
決済日 |
手数料が承認され、引き出し可能となる日付 |
注 |
その金額が発生した期間 |
settlement_id |
一意の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 |
settlement_id |
一意のIDは、加盟店による承認済み手数料を示しています | 12345 |
戻り値
| キー | 説明 |
|---|---|
brand_id |
ブランドID |
mcid |
ブランド固有の識別子 |
merchant_name |
ブランド名 |
order_id |
注文ID |
注文日時 |
取引時間 |
sale_amount |
販売額 |
sale_comm |
販売手数料 |
ステータス |
コミッションの状況 |
uid |
ユーザー固有のトラッキング変数 |
prod_id |
製品ID |
注文単位 |
注文単位 数量 |
settlement_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日 |
支払日（終了日） |
支払日（期末）（YYYY-MM-DD） | 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日 |
支払日（終了日） |
支払日（期末）（YYYY-MM-DD） | 2024年1月31日 |
戻り値
| キー | 説明 |
|---|---|
brand_id |
ブランドID |
mcid |
ブランド固有の識別子 |
金額 |
手数料額またはボーナス額 |
検証日 |
委託が承認された日付 |
タイプ |
その種類は、歩合給またはボーナスとなる場合があります |
注 |
その金額が発生した期間 |
settlement_id |
一意のIDは、承認済みのコミッションを示しています |
merchant_name |
店舗名 |
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、Amazon、ウォルマート、間接販売 | 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、Amazon、間接販売 | D2C |
brand_id |
ブランドID | 66303 |
mcid |
ブランド固有の識別子 | ulike0 |
トラック |
トラッキングリンク内のコード | track123 |
タイプ |
クーポンには、「クーポン」と「ディール」の2種類があります。 | クーポン |
国 |
クーポンが利用できる国 | 米国 |
origin_category |
クーポンを提供している店舗のカテゴリー | アパレル |
レベル |
レベル1～4。レベル1が最高です。 | 1 |
lang |
クーポンの言語 | ja |
1ページあたりの件数 |
1ページあたりの件数（デフォルトは50件、最大2000件） | 100 |
ページ |
現在のページインデックス（1から始まる） | 1 |
created_at |
作成日時 (YYYY-MM-DD) | 2024年1月1日 |
更新日時 |
更新日時 (YYYY-MM-DD) | 2024年1月1日 |
戻り値
| キー | 説明 |
|---|---|
creative_id |
クリエイティブID |
brand_id |
ブランドID |
制限 |
クーポンの利用制限 |
キーワード |
キーワード |
画像 |
クーポンの画像 |
サムネイル |
サムネイル画像 |
smart_url |
スマート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"
}
]
}
データフィード
投稿
リスト
データフィード一覧 API
ブランドから商品データフィードを取得する。
エンドポイント
https://app.partnerboost.com/api.php?mod=datafeed&op=list
必須パラメータ
| キー | 説明 | 例 |
|---|---|---|
トークン |
チャンネルのAPIトークン | 79e33f8dac5a0be8579018760cff4cc227fb888d |
オプションのパラメータ
| キー | 説明 | 例 |
|---|---|---|
タイプ |
返却形式：json（デフォルト）またはxml | json |
ブランドタイプ |
ブランドの種類：TikTok、DTC、ウォルマート | DTC |
brand_id |
ブランドID | 66303 |
mcid |
ブランド固有の識別子 | ulike0 |
ページ |
現在のページ一覧 | 1 |
上限 |
1ページあたりの商品数（最大100件） | 50 |
キーワード |
キーワード | シャツ |
価格帯 |
「0～75」、「75～150」、「150～300」、「300～500」、「500～1000」、「1000以上」のいずれか | 75～150 |
min_discount |
75、50、25、10のうちの1つ | 25 |
戻り値
| キー | 説明 |
|---|---|
名前 |
製品名 |
説明 |
商品説明 |
brand_id |
ブランドID |
mcid |
ブランド固有の識別子 |
merchant_name |
この商品を販売している販売業者の名称 |
url |
元の商品のURL |
画像 |
商品の画像へのリンク |
SKU |
商品のSKU |
カテゴリ |
商品カテゴリ |
価格 |
当該商品の現在の価格 |
tracking_url |
アフィリエイト追跡URL |
tracking_url_short |
短縮されたアフィリエイト追跡URL |
tracking_url_smart |
スマートアフィリエイト追跡URL |
更新日時 |
最終更新日時 |
デモを申し込む
{
"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"
}
]
}
アマゾン
Amazon Publisher API のベース URL： https://amazon-service.partnerboost.com/amazon_api. 以下のすべてのエンドポイントは 投稿 JSON本文付き application/json.
POST
get_fba_products
商品取得API
条件（ページ分割、国、ブランド、ASIN、プロモーションなど）に基づいて、Amazonの商品をフィルタリングおよび検索します。
エンドポイント
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
get_fba_products_link
商品リンク（商品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
get_amazon_joined_brands
提携ブランド取得API
提携しているAmazonブランドをリストアップしてください（ページ分けあり）。
エンドポイント
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
get_fba_brand_link
ストアフロントリンク取得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
get_amazon_link_status
リンクステータス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
get_amazon_report
Amazon Report 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
get_latest_associates_products
アソシエイト ASIN リスト API
Amazonアソシエイト・プログラムの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
get_latest_acc_products
Amazon Creator Connection ASINリストAPI
Amazon Creator Connection（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"
}
]
}
}
