淘寶API使用須知
淘寶聯盟設置使用螞蟻星球淘寶API需要先申請apikey并進行淘寶授權，您可以螞蟻星球推廣中心->開發管理->插件接入查看apikey，單個螞蟻星球賬號只能申請一個apikey。螞蟻星球開放API是免費使用的，但螞蟻星球保留對各接口進行調整的權利，我們會在調整時及時給予通知，也請您持續關注我們的公告。
接口地址： http://api-gw.haojingke.com/index.php/v1/api/tb/getunionurl
支持格式： json
請求方式： get/post
請求示例： http://api-gw.haojingke.com/index.php/v1/api/tb/getunionurl?apikey=您的apikey&item_id=
請求參數說明：
| 名稱 | 類型 | 必填 | 說明 |
|---|---|---|---|
| apikey | String | 是 | 螞蟻星球apikey，請將示例中的key替換成您的key |
| item_id | Integer | 是 | 寶貝ID（*必要） |
| pid | String | 是 | mm_0000_0000_000， 推廣位ID（可在開發者中心設置默認pid）（*必要 需是授權淘寶號下的推廣位，如果請求的時候攜帶了渠道id請求，則該pid需是渠道管理下面的渠道專屬推廣位） |
| relation_id | String | 否 | 渠道ID |
| special_id | String | 否 | 會員運營ID |
| external_id | String | 否 | 淘寶客外部用戶標記，如自身系統賬戶ID；微信ID等，需配合渠道接口（publisherget）獲取special_id， |
| xid（新） | String | 否 | 團長與下游渠道合作的特殊標識，用于統計渠道推廣效果（*itemid、xid二選一 或 二選二） |
| get_tkl | String | 否 | 是否返回淘口令（0.否；1.是）（默認0）（選填） |
| title | String | 否 | 淘口令標題（用于返回淘口令*get_tkl等于1時為必填參數*，需超過8個字符） |
| logo | String | 否 | 淘口令彈窗的圖片 |
| positionid | Int | 否 | 自定義推廣位id，整型數字 (螞蟻星球開發者中心推廣位管理中的uid) |
JSON返回示例：
{
"data": {
"category_id": "1625",分類ID
"coupon_click_url": "https://uland.taobao.com/coupon/edetail?e=BT5m4kNPa%2B6lhHvvyUNXZfh8CuWt5YH5OVuOuRD5gLJMmdsrkidbOcgNAa9X6T79uG1ZaNECU%2FS28bztD9ZlyYv7WfPDvKbYXRuv7xpz1L7QEUCpE4O7Xc3und6mwXdKUqRUtTtZSji%2Bqi5RslGGce9tF5RNjUJqG%2Bsvhyg3hhpwdcbFHm9iHJFnYDcWDF2oMbGusFEnDH5i3DOS540Dp0CLoSLDztJNN9LVSIjIO7oqwPU18YFMoLjtdx6zVCzZH4P3zKhUcU02GOdIiNXzalVusqqnhify&traceId=0bb61b0c16182117715661915ef5f6&&union_lens=lensId:TAPI@1618211771@0b505cf6_087b_178c4f014cd_8025@01;linkRuleId:1",已轉鏈后的您的二合一鏈接（有券產品）或s.click鏈接（無券產品），可直接使用
"coupon_end_time": "2021-04-14",優惠券過期時間 （有優惠券時才有此字段）
"coupon_info": "滿19元減5元",優惠券信息，格式都是“滿xx元減xx元”（有優惠券時才有此字段）
"coupon_remain_count": "98000",剩余優惠券數量，當為0時優惠券失效。（有優惠券時才有此字段）
"coupon_start_time": "2021-04-12",優惠券開始時間（有優惠券時才有此字段）
"coupon_total_count": "100000",優惠券發放總量 （有優惠券時才有此字段）
"item_id": "580442138828",商品ID
"item_url": "https://detail.tmall.com/item.htm?id=580442138828",產品鏈接
"max_commission_rate": "20.06",常規傭金率：當不入參special_id、relation_id、external_id時，展示常規傭金率(%)
"reward_info": "0",比價場景專用，當系統檢測到入參消費者ID購買當前商品會獲得《天天開彩蛋》玩法的彩蛋時，該字段顯示1，否則為0
"cat_leaf_name": "短襪/打底襪/絲襪/美腿襪",分類子葉
"cat_name": "女士內衣/男士內衣/家居服",分類名
"nick": "bonas寶娜斯專賣店", 店鋪名稱
"num_iid": "580442138828",商品ID
"pict_url": "https://img.alicdn.com/bao/uploaded/i3/3162439037/O1CN01UaM8VD2Gczv0diNOn_!!0-item_pic.jpg",商品主圖
"presale_deposit": "0",預售商品-定金（元）
"presale_end_time": "0",預售商品-付定金結束時間（毫秒）
"presale_start_time": "0",預售商品-付定金開始時間（毫秒）
"presale_tail_end_time": "0",預售商品-付定金結束時間（毫秒）
"presale_tail_start_time": "0",預售商品-付尾款開始時間（毫秒）
"provcity": "浙江 金華",商品所在地
"reserve_price": "99",商品一口價格
"seller_id": "3162439037",賣家id
"small_images": { [
"https://img.alicdn.com/i2/3162439037/O1CN01OOSKtN2GczlKWg0Tn_!!3162439037.jpg",
"https://img.alicdn.com/i3/3162439037/O1CN01FdhGfq2Gczq0pbUGJ_!!3162439037-0-lubanu-s.jpg",
"https://img.alicdn.com/i3/3162439037/O1CN0166iB502GcznSLVfAT_!!3162439037.jpg",
"https://img.alicdn.com/i2/3162439037/O1CN01zsCNAd2Gczpt1fbDd_!!3162439037-0-lubanu-s.jpg"
]
},商品小圖列表
"superior_brand": "0",是否品牌精選，0不是，1是
"title": "肉色絲襪女薄款2020新款網紅黑絲連褲襪春秋款夏季光腿神器菠蘿襪",短鏈接
"tmall_play_activity_end_time": "0",天貓限時搶可售 -結束時間（毫秒）
"tmall_play_activity_start_time": "0",天貓限時搶可售 -開始時間（毫秒）
"user_type": "1",賣家類型，1、表示天貓，0、表示淘寶，3表示特價版
"volume": "190409",最近30天銷量
"zk_final_price": "19.9",產品折后價
"coupon_short_url": "https://s.click.taobao.com/awxzQpu",短鏈接
"ios_tbk_pwd": "8￥ue2gXc4PL6M￥ https://m.tb.cn/h.4pGp2tW 肉色絲襪女薄款2020新款網紅黑絲連褲襪春秋款夏季光腿神器菠蘿襪",針對聯盟2020-8-31新出的適用于IOS14的淘口令文案
"tbk_pwd": "￥ue2gXc4PL6M￥",淘口令，此口令是已轉化成你自己PID的口令
"tkl": "9(ue2gXc4PL6M) /" 蘋果IOS和安卓通用的簡化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd
},
"message": "success",提示信息
"status_code": 200狀態碼 200表示請求成功
}
接口地址： http://api-gw.haojingke.com/index.php/v1/api/tb/activity
支持格式： json
請求方式： get/post
請求示例： http://api-gw.haojingke.com/index.php/v1/api/tb/activity?apikey=您的apikey&activity_id=
請求參數說明：
| 名稱 | 類型 | 必填 | 說明 |
|---|---|---|---|
| apikey | String | 是 | 螞蟻星球apikey，請將示例中的key替換成您的key |
| activity_id | String | 是 | 官方活動物料id |
| pid | String | 是 | mm_0000_0000_000， 推廣位ID（可在開發者中心設置默認pid）（*必要 需是授權淘寶號下的推廣位，如果請求的時候攜帶了渠道id請求，則該pid需是渠道管理下面的渠道專屬推廣位） |
| relation_id | String | 否 | 渠道ID |
| union_id | String | 否 | 自定義輸入串，英文和數字組成，長度不能大于12個字符，區分不同的推廣渠道 |
| get_tkl | String | 否 | 是否返回淘口令（0.否；1.是）（默認0）（選填） |
| title | String | 否 | 淘口令標題（用于返回淘口令*get_tkl等于1時為必填參數*，需超過8個字符） |
| logo | String | 否 | 淘口令彈窗的圖片 |
JSON返回示例：
{
"data": {
"click_url": "https://s.click.taobao.com/t?union_lens=lensId%3AMAPI%401618206678%402104ccc4_07d2_178c4a25e2a_7e33%4001%3BeventPageId%3A20150318020000462&e=m%3D2%26s%3DGPj1xpRhKgVw4vFB6t2Z2iperVdZeJviPI5Rhak06vZnX1vWUft3ZXCooVp%2Bhaq3%2BCItzojEYRP3HC9F1AE3cLIaDCBC%2F4E2GNMUGoCunc8TV3YQzXSFYdftwTU8qYAgsynDUllKeZHd0%2Bv22oF73US1A3RpE0wVDPxWoA2%2FDBPrMYvMaxVVKsK1DMtXGlsK08EP%2FnJs4K5AFEHVckI7b9XSpRlaJaElaJe2Xd4pkBlyeNAoQluSajK%2FmpnItMR0VaJBM3Fz6%2BgPTtU%2FdIEvWZRwfjTt4rjnSkKImelLej2UB7RP8CFvRlMb9ncl7geF8PwOkD4ulZdpYjsi4suCq9icWZOJx2fePm5r2egYQ0iiZ%2BQMlGz6FQ%3D%3D",鏈接
"material_oss_url": "http://creative-material-public.oss-cn-shanghai.aliyuncs.com/a/p/20150318020000462.zip",物料素材下載地址
"page_end_time": "2021-08-19",活動結束時間
"page_name": "聚劃算百億補貼頁面",會場名稱
"page_start_time": "2020-09-16",活動開始時間
"terminal_type": "2",投放平臺：1-PC，2-無線
"coupon_short_url": "https://s.click.taobao.com/BScELpu",短鏈
"ios_tbk_pwd": "3.0￥QdhgXcV9dnZ￥ https://m.tb.cn/h.4ptF0dY 點擊“打開”查看并瀏覽頁面詳情，精選商品任您選購",針對聯盟2020-8-31新出的適用于IOS14的淘口令文案
"tbk_pwd": "￥QdhgXcV9dnZ￥",淘口令，此口令是已轉化成你自己PID的口令
"tkl": "8(QdhgXcV9dnZ) /"蘋果IOS和安卓通用的簡化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd
},
"message": "success",提示信息
"status_code": 200狀態碼 200表示請求成功
}
接口地址： http://api-gw.haojingke.com/index.php/v1/api/tb/shop
支持格式： json
請求方式： get/post
請求示例： http://api-gw.haojingke.com/index.php/v1/api/tb/shop?apikey=您的apikey&user_id=
請求參數說明：
| 名稱 | 類型 | 必填 | 說明 |
|---|---|---|---|
| apikey | String | 是 | 螞蟻星球apikey，請將示例中的key替換成您的key |
| user_id | String | 是 | 賣家ID串，用','分割 |
| pid | String | 是 | mm_0000_0000_000， 推廣位ID（可在開發者中心設置默認pid）（*必要 需是授權淘寶號下的推廣位，如果請求的時候攜帶了渠道id請求，則該pid需是渠道管理下面的渠道專屬推廣位） |
| relation_id | String | 否 | 渠道ID |
| union_id | String | 否 | 自定義輸入串，英文和數字組成，長度不能大于12個字符，區分不同的推廣渠道 |
| get_tkl | String | 否 | 是否返回淘口令（0.否；1.是）（默認0）（選填） |
| title | String | 否 | 淘口令標題（用于返回淘口令*get_tkl等于1時為必填參數*，需超過8個字符） |
| logo | String | 否 | 淘口令彈窗的圖片 |
JSON返回示例：
{
"data": {
"click_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DSRD5KSEVZ0Bw4vFB6t2Z2jAVflQIoZepyK8Cckff7TVRAdhuF14FMfGUfXy3ofD5t4hWD5k2kjO3bcmU2DXU%2FuW76gk5BrvMBXTcnbeNW6f8VNjy6FCpN0m4argXYs%2F4Ke3%2FbelnU7eOJ4hmg2sGJDMrRWVrG%2F%2BL3rfiG8%2Bae61A8ZU6Y7TB%2FigSDy28JSWhQIAW7b5xhq7GDmntuH4VtA%3D%3D&union_lens=lensId:TAPI@1618213923@2105de0e_37d2_178c510ec00_8dc1@01",
"user_id": "3162439037",賣家id
"ios_tbk_pwd": "6￥DfwXXc4xFqw￥ https://m.tb.cn/h.4LVFUqR bonas寶娜斯專賣店",針對聯盟2020-8-31新出的適用于IOS14的淘口令文案
"tbk_pwd": "￥DfwXXc4xFqw￥",淘口令，此口令是已轉化成你自己PID的口令
"tkl": "0(DfwXXc4xFqw) /",蘋果IOS和安卓通用的簡化淘口令。可替代 tbk_pwd 和 ios_tbk_pwd
"coupon_short_url": "https://s.click.taobao.com/iK6vQpu"短鏈
},
"message": "success",提示信息
"status_code": 200狀態碼 200表示請求成功
}
