淘宝API使用须知
淘宝联盟设置使用蚂蚁星球淘宝API需要先申请apikey并进行淘宝授权,您可以在本页面上方点击申请按钮或直接进入个人中心开放API页面申请,单个蚂蚁星球账号只能申请一个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等 |
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表示请求成功 }
接口地址: http://api-gw.haojingke.com/index.php/v1/api/tb/dec
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/dec?apikey=您的apikey&content=
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
content | String | 是 | 需要解析的淘口令 |
pid | String | mm_0000_0000_000, 推广位ID(可在开发者中心设置默认pid)(*必要 需是授权淘宝号下的推广位,如果请求的时候携带了渠道id请求,则该pid需是渠道管理下面的渠道专属推广位) |
JSON返回示例:
{ "data": { "seller_id": "3162439037"卖家id 店铺口令才返回 "click_url": "https://s.click.taobao.com/t?e=m%3D2%26s%3DOiQtBrv%2FIEccQipKwQzePOeEDrYVVa64yK8Cckff7TVRAdhuF14FMWPXfTqMM28qxq3IhSJN6GS3bcmU2DXU%2FuW76gk5BrvMBXTcnbeNW6f8VNjy6FCpN0m4argXYs%2F4Ke3%2FbelnU7eOJ4hmg2sGJMYjGr6SHqGc3rfiG8%2Bae61A8ZU6Y7TB%2Fodfn9d%2FEbW45tvZIfa9UWCxUgJZyfD3VRbICjDpqO%2FEUSwYGlubnWs%3D&union_lens=lensId:TAPI@1618215773@21049948_088f_178c52d2429_1241@0245dbGTfTGo6cEGCJwkJGBz",商品淘客转链链接 "num_iid": "580442138828",商品id 商品口令才返回 "origin_pid": "mm_000_000_000",入参淘口令推广链接中的pid,如果不属于当前调用的推广者则展示“0” "origin_url": "https://uland.taobao.com/coupon/edetail?e=BT5m4kNPa%2B6lhHvvyUNXZfh8CuWt5YH5OVuOuRD5gLJMmdsrkidbOcgNAa9X6T79uG1ZaNECU%2FS28bztD9ZlyYv7WfPDvKbYXRuv7xpz1L7QEUCpE4O7Xc3und6mwXdKUqRUtTtZSji%2Bqi5RslGGce9tF5RNjUJqG%2Bsvhyg3hhpwdcbFHm9iHJFnYDcWDF2oMbGusFEnDH5i3DOS540Dp0CLoSLDztJNN9LVSIjIO7oqwPU18YFMoLjtdx6zVCzZH4P3zKhUcU02GOdIiNXzalVusqqnhify&traceId=0bb6a9c316182157731906086e09ae&relationId=2107987734&&union_lens=lensId:TAPI@1618215773@21049948_088f_178c52d2429_1241@01;linkRuleId:1&un=54ea29d1a40d5e583b78f3f56252ec44&share_crt_v=1&ut_sk=1.utdid_32548960_1618215773531.TaoPassword-Outside.taoketop&spm=a2159r.13376465.0.0&sp_tk=RkttblhjZlRWZlM=&bxsign=tcdf6pbOyF93ibylrrEPFJn_MqJZPP4QOAC42Bd95UStk6WgNfrhgYkxYjWwBS-lIDXWl4RB7VpNdGSvXUvDCTISVjw9fgvccDNJb0xgR3L1f8" 入参淘口令对应原始链接 }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/material
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/material?apikey=您的apikey&material_id=
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
material_id | String | 是 | 官方提供的物料Id(详细物料id见:https://market.m.taobao.com/app/qn/toutiao-new/index-pc.html#/detail/10628875?_k=gpov9a) |
pid | String | 是 | mm_0000_0000_000, 推广位ID(可在开发者中心设置默认pid)(*必要 需是授权淘宝号下的推广位,如果请求的时候携带了渠道id请求,则该pid需是渠道管理下面的渠道专属推广位) |
page_no | Integer | 否 | 第几页,默认:1 |
page_size | Integer | 否 | 页大小,默认20,1~100 |
device_type | String | 否 | 智能匹配-设备号类型:IMEI,或者IDFA,或者UTDID(UTDID不支持MD5加密),或者OAID |
device_encrypt | String | 否 | 智能匹配-设备号加密类型:MD5,类型为OAID时不传 |
device_value | String | 否 | 智能匹配-设备号加密后的值(MD5加密需32位小写),类型为OAID时传原始OAID值 |
content_id | String | 否 | 内容专用-内容详情ID |
content_source | String | 否 | 内容专用-内容渠道信息 |
item_id | String | 否 | 商品ID,用于相似商品推荐 |
JSON返回示例:
{ "data": { "result_list": { "category_id": "50002711", "click_url": "//s.click.taobao.com/t?e=m%3D2%26s%3DTZLslWXL1Z9w4vFB6t2Z2ueEDrYVVa64Dne87AjQPk9yINtkUhsv0JxG7BI747GLYK4FTlhdvmc7we%2BafwX%2Fjo0HBRDi8pKBmlF4sUmdvy9Uhon%2BqT93lSQjO9J4i5qlLrHGZgcOhEAI%2FhLx0e8TS%2B83tSLYZXWBSrCgwPqUuebF3IcC7BbJ1mzX28gsrLL2wrUMy1caWwobXhXJ8Jw4GKJn5AyUbPoV&scm=1007.15348.115058.0_3756&pvid=36a42655-e5a8-4fb4-87b6-e5a846e8bf31&app_pvid=59590_33.6.194.12_935_1618223154173&ptl=floorId:3756;originalFloorId:3756;pvid:36a42655-e5a8-4fb4-87b6-e5a846e8bf31;app_pvid:59590_33.6.194.12_935_1618223154173&union_lens=lensId%3AMAPI%401618223154%4036a42655-e5a8-4fb4-87b6-e5a846e8bf31_619805037000%401", "commission_rate": "2.4", "coupon_amount": "5", "coupon_click_url": "//uland.taobao.com/coupon/edetail?e=oPXojLQgcnUNfLV8niU3R5TgU2jJNKOfNNtsjZw%2F%2FoJgbeYrGsKZmGFlas1mAK%2BVkMyrXyxRLrrEbbp8JvC0yemFKyIN1bVX65OH1WfUm95Uf2TiFOebe4uZSwRFmuoH19yemPYYxwcwifnWLxLR%2B22QlU1TT1iZF%2FilooiQSIfMnEXAZ5cm3ItRmuAC1KAsumu2abnFhdtVbrKqp4Yn8g%3D%3D&&app_pvid=59590_33.6.194.12_935_1618223154173&ptl=floorId:3756;app_pvid:59590_33.6.194.12_935_1618223154173;tpp_pvid:36a42655-e5a8-4fb4-87b6-e5a846e8bf31&union_lens=lensId%3AMAPI%401618223154%4036a42655-e5a8-4fb4-87b6-e5a846e8bf31_619805037000%401", "coupon_end_time": "1618502399000", "coupon_remain_count": "6000", "coupon_share_url": "//uland.taobao.com/coupon/edetail?e=oPXojLQgcnUNfLV8niU3R5TgU2jJNKOfNNtsjZw%2F%2FoJgbeYrGsKZmGFlas1mAK%2BVkMyrXyxRLrrEbbp8JvC0yemFKyIN1bVX65OH1WfUm95Uf2TiFOebe4uZSwRFmuoH19yemPYYxwcwifnWLxLR%2B22QlU1TT1iZF%2FilooiQSIfMnEXAZ5cm3ItRmuAC1KAsumu2abnFhdtVbrKqp4Yn8g%3D%3D&&app_pvid=59590_33.6.194.12_935_1618223154173&ptl=floorId:3756;app_pvid:59590_33.6.194.12_935_1618223154173;tpp_pvid:36a42655-e5a8-4fb4-87b6-e5a846e8bf31&union_lens=lensId%3AMAPI%401618223154%4036a42655-e5a8-4fb4-87b6-e5a846e8bf31_619805037000%401", "coupon_start_fee": "9.0", "coupon_start_time": "1617206400000", "coupon_total_count": "10000", "item_description": "大容量巨无霸 束口可折叠 防潮防水涂层", "item_id": "619805037000", "level_one_category_id": "122928002", "level_one_category_name": "收纳整理", "nick": "简玫旗舰店", "pict_url": "//img.alicdn.com/bao/uploaded/i1/2200796515358/O1CN01kvyyUg1pS0j6tftC4_!!0-item_pic.jpg", "reserve_price": "19.9", "seller_id": "2200796515358", "short_title": "特大号巨能装衣服棉被子家用收纳箱", "small_images": { "string": [ "//img.alicdn.com/i3/2200796515358/O1CN01jvEDD91pS0j76eZAm_!!2200796515358.jpg", "//img.alicdn.com/i1/2200796515358/O1CN01FLWS8P1pS0j64Y4Fq_!!2200796515358.jpg", "//img.alicdn.com/i1/2200796515358/O1CN014ArIEE1pS0j2nDYLy_!!2200796515358.jpg", "//img.alicdn.com/i2/2200796515358/O1CN01nNHanR1pS0j79eWlE_!!2200796515358.png" ] }, "sub_title": "大容量巨无霸 束口可折叠 防潮防水涂层", "title": "特大号收纳袋巨能装衣服棉被子收纳箱搬家打包整理袋衣物袋子家用", "tmall_play_activity_end_time": "0", "tmall_play_activity_start_time": "0", "user_type": "1", "volume": "695", "zk_final_price": "9.9" } }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/getorder
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/getorder?apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
start_time | String | 是 | 订单查询开始时间 如 2021-03-29 16:00:00 |
end_time | String | 是 | 订单查询结束时间 如 2021-03-29 17:00:00,订单开始时间至订单结束时间,中间时间段日常要求不超过3个小时,但如618、双11、年货节等大促期间预估时间段不可超过20分钟,超过会提示错误,调用时请务必注意时间段的选择,以保证亲能正常调用! |
query_type | String | 否 | 查询时间类型,1:按照订单淘客创建时间查询,2:按照订单淘客付款时间查询,3:按照订单淘客结算时间查询 |
position_index | Integer | 否 | 位点,除第一页之外,都需要传递;前端原样返回。 |
page_no | Integer | 否 | 第几页,默认:1 |
page_size | Integer | 否 | 页大小,默认20,1~100 |
member_type | String | 否 | 推广者角色类型,2:二方,3:三方,不传,表示所有角色 |
tk_status | String | 否 | 淘客订单状态,12-付款,13-关闭,14-确认收货,3-结算成功;不传,表示所有状态 |
jump_type | String | 否 | 跳转类型,当向前或者向后翻页必须提供,-1: 向前翻页,1:向后翻页 |
order_scene | String | 否 | 场景订单场景类型,1:常规订单,2:渠道订单,3:会员运营订单,默认为1 |
JSON返回示例:
{ "data": { "has_next": "false", "has_pre": "false", "page_no": "1", "page_size": "20", "position_index": "1617004805_20oeIXGy6qL2|1617005309_1vEV60qofeh2", "results": { "publisher_order_dto": [ ] } }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/getorderrefund
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/getorderrefund?apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
start_time | String | 是 | 订单查询开始时间 如 2021-03-29 |
page_no | Integer | 否 | 第几页,默认:1 |
page_size | Integer | 否 | 页大小,默认20,1~100 |
search_type | String | 否 | 1-维权发起时间,2-订单结算时间(正向订单),3-维权完成时间,4-订单创建时间 |
refund_type | String | 否 | 1 表示2方,2表示3方,0表示不限 |
biz_type | String | 否 | 1代表渠道关系id,2代表会员关系id |
JSON返回示例:
{ "data": { "biz_error_code": "0", "data": { "page_no": "100", "page_size": "1", "total_count": "2" }, "result_code": "200" }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/getorderpunish
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/getorderpunish?apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
start_time | String | 是 | 查询开始时间,以taoke订单创建时间开始 如 2021-03-29 |
page_no | Integer | 否 | 第几页,默认:1 |
page_size | Integer | 否 | 页大小,默认20,1~100 |
span | String | 否 | 查询时间跨度,不超过30天,单位是天 |
relation_id | String | 否 | 渠道关系id |
tb_trade_id | String | 否 | 子订单号 |
order_scene | String | 否 | 场景订单场景类型,1:常规订单,2:渠道订单,3:会员运营订单,默认为1 |
JSON返回示例:
{ "data": { "biz_error_code": "0", "data": { "page_no": "1", "page_size": "100", "total_count": "0" }, "result_code": "200" }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/invitecodeget
注:此接口需要淘宝有渠道权限
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/invitecodeget?apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
relation_app | String | 否 | 默认common 备案的场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)。如不填默认common。查询会员信息只需填写common即可 |
code_type | String | 否 | 邀请码类型,1 - 渠道邀请,2 - 渠道裂变,3 -会员邀请 |
JSON返回示例:
{ "data": { "inviter_code": "KAKFF7" }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/publisher
注:此接口需要淘宝有渠道权限
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/publisher?apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
relation_from | String | 否 | 渠道备案 - 来源,取链接的来源 |
offline_scene | String | 否 | 渠道备案 - 线下场景信息,1 - 门店,2- 学校,3 - 工厂,4 - 其他 |
online_scene | String | 否 | 渠道备案 - 线上场景信息,1 - 微信群,2- QQ群,3 - 其他 |
inviter_code | String | 是 | 必选,淘宝客邀请渠道或会员的邀请码 |
accesstoken | String | 是 | 必选,您的客户(即要成为你的渠道方)进行授权后得到的access token值 |
info_type | String | 否 | 类型,必选 默认为1: |
note | String | 否 | 媒体侧渠道备注 |
register_info | String | 否 | 线下备案注册信息,字段包含: 电话号码(phoneNumber,必填),省(province,必填),市(city,必填),区县街道(location,必填),详细地址(detailAddress,必填),经营类型(career,线下个人必填),店铺类型(shopType,线下店铺必填),店铺名称(shopName,线下店铺必填),店铺证书类型(shopCertifyType,线下店铺选填),店铺证书编号(certifyNumber,线下店铺选填) |
JSON返回示例:
{ "data": "", "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/publishertkl
注:此接口需要淘宝有渠道权限
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/publishertkl?apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
inviter_code | String | 否 | 淘宝客邀请渠道或会员的邀请码 |
title | String | 否 | 口令标题 默认:渠道会员备案 |
logo | String | 否 | 淘口令图片,默认图地址 https://img.91fyt.com/ta8LtdUstq.png |
rtag | String | 是 | 必选,你用于标识该客户身份的标识,它必须是在你的数据库中唯一的,可通过查询渠道备案绑定到用户。 |
JSON返回示例:
{ "data": { "ios_tbk_pwd": "8¥dMIOXVDPOWq¥ https://m.tb.cn/h.4IOz2tb 點击“打开”查看并浏览页面详情,精选商品任您选购", "tbk_pwd": "¥dMIOXVDPOWq¥", "tkl": "9 £dMIOXVDPOWq〒/" }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }
接口地址:
http://api-gw.haojingke.com/index.php/v1/api/tb/publisherget?
注:此接口需要淘宝有渠道权限
支持格式: json
请求方式: get/post
请求示例: http://api-gw.haojingke.com/index.php/v1/api/tb/publisherget??apikey=您的apikey
请求参数说明:
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
apikey | String | 是 | 蚂蚁星球apikey,请将示例中的key替换成您的key |
relation_app | String | 否 | 默认common 备案的场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)。如不填默认common。查询会员信息只需填写common即可 |
info_type | String | 否 | 类型,必选 1:渠道信息;2:会员信息 默认1 |
page_no | Integer | 否 | 第几页,默认:1 |
page_size | Integer | 否 | 页大小,默认20,1~100 |
relation_id | String | 否 | 渠道独占 - 渠道关系ID |
special_id | String | 否 | 会员独占 - 会员运营ID |
external_id | String | 否 | 淘宝客外部用户标记,如自身系统账户ID;微信ID等 |
external_type | String | 否 | 1-微信、2-微博、3-抖音、4-快手、5-QQ,0-其他;默认为0 |
JSON返回示例:
{ "data": { "inviter_list": { "map_data": { "account_name": "卡**", "create_date": "2021-05-1 10:52:27", "note": [], "offline_scene": "其他", "online_scene": "其他", "punish_status": "0", "real_name": "**司", "relation_app": "common", "relation_id": "21231021", "root_pid": "mm_xxx_xxx_xxx", "rtag": "1" } }, "root_pid_channel_list": { "string": "mm_xxx_xxx_xxx" }, "total_count": "1" }, "message": "success",提示信息 "status_code": 200状态码 200表示请求成功 }