淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
platform	Number	可选	1	默认值：1	1：PC，2：无线，默认：1
pid	String	必须	mm_123_123_123		三方pid，满足mm_xxx_xxx_xxx格式
num_iids	String	可选	123,456		商品ID串，用逗号分割，从taobao.tbk.item.coupon.get接口获取num_iid字段，最大40个。（如果传入了没有优惠券的宝贝num_iid，则优惠券相关的字段返回为空，请做好容错）

名称	类型	示例值	描述
results	TbkCoupon []		data
└ small_images String [] http://img4.tbcdn.cn/tfscom/i3/TB1vPdxHXXXXXbtXpXXXXXXXXXX_!!2-item_pic.png 商品小图列表 └ coupon_total_count Number 5000 优惠券总量 └ commission_rate String 1.80 佣金比率(%) └ user_type Number 1 卖家类型，0表示集市，1表示商城 └ title String 奥克斯理发器电推剪电推子充电式成人儿童剪发器电动剃头刀家用商品标题 └ coupon_info String 满188元减5元优惠券面额 └ shop_title String 奥克斯品胜专卖店店铺名称 └ category Number 1 后台一级类目 └ num_iid String 1 itemId └ coupon_remain_count Number 3395 优惠券剩余量 └ zk_final_price String 269.00 折扣价 └ coupon_start_time String 2016-09-05 优惠券开始时间 └ nick String 奥克斯品胜专卖店卖家昵称 └ seller_id Number 2884767143 卖家id └ volume Number 76927 30天销量 └ coupon_end_time String 2016-10-01 优惠券结束时间 └ coupon_click_url String https://uland.taobao.com/coupon/edetail?e=8Iirp0qvW4t9%2BIHBh%2BrOiioPr%2BRaKTNCdUZfqAaohJnOVyPi0MUz8w13gui0W49o5PdvjO4eOnOie%2FpBy9wBFg%3D%3D&pid=mm_0_0_0&af=1&itemId=531940770655 商品优惠券推广链接 └ pict_url String http://img03.daily.taobao.net/tfscom/i1/TB1XTOqKXXXXXaSXVXXXXXXXXXX_!!0-item_pic.jpg 商品主图 └ item_url String http://h5.m.taobao.com/awp/core/detail.htm?id=531940770655 商品详情页链接地址 └ input_num_iid String 1 原始入参商品id └ annual_vol String 1万+ 年销量

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkItemidCouponGetRequest req = new TbkItemidCouponGetRequest();
req.setPlatform(1L);
req.setPid("mm_123_123_123");
req.setNumIids("123,456");
TbkItemidCouponGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

XML示例
JSON示例

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

<tbk_itemid_coupon_get_response>
    <results>
        <tbk_coupon>
            <small_images>
                <string>http://img4.tbcdn.cn/tfscom/i3/TB1vPdxHXXXXXbtXpXXXXXXXXXX_!!2-item_pic.png</string>
            </small_images>
            <coupon_total_count>5000</coupon_total_count>
            <commission_rate>1.80</commission_rate>
            <user_type>1</user_type>
            <title>奥克斯理发器电推剪电推子充电式成人儿童剪发器电动剃头刀家用</title>
            <coupon_info>满188元减5元</coupon_info>
            <shop_title>奥克斯品胜专卖店</shop_title>
            <category>1</category>
            <num_iid>1</num_iid>
            <coupon_remain_count>3395</coupon_remain_count>
            <zk_final_price>269.00</zk_final_price>
            <coupon_start_time>2016-09-05</coupon_start_time>
            <nick>奥克斯品胜专卖店</nick>
            <seller_id>2884767143</seller_id>
            <volume>76927</volume>
            <coupon_end_time>2016-10-01</coupon_end_time>
            <coupon_click_url>https://uland.taobao.com/coupon/edetail?e=8Iirp0qvW4t9%2BIHBh%2BrOiioPr%2BRaKTNCdUZfqAaohJnOVyPi0MUz8w13gui0W49o5PdvjO4eOnOie%2FpBy9wBFg%3D%3D&amp;pid=mm_0_0_0&amp;af=1&amp;itemId=531940770655</coupon_click_url>
            <pict_url>http://img03.daily.taobao.net/tfscom/i1/TB1XTOqKXXXXXaSXVXXXXXXXXXX_!!0-item_pic.jpg</pict_url>
            <item_url>http://h5.m.taobao.com/awp/core/detail.htm?id=531940770655</item_url>
            <input_num_iid>1</input_num_iid>
            <annual_vol>1万+</annual_vol>
        </tbk_coupon>
    </results>
</tbk_itemid_coupon_get_response>

{
    "tbk_itemid_coupon_get_response":{
        "results":{
            "tbk_coupon":[
                {
                    "small_images":{
                        "string":[
                            "http:\/\/img4.tbcdn.cn\/tfscom\/i3\/TB1vPdxHXXXXXbtXpXXXXXXXXXX_!!2-item_pic.png"
                        ]
                    },
                    "coupon_total_count":5000,
                    "commission_rate":"1.80",
                    "user_type":1,
                    "title":"奥克斯理发器电推剪电推子充电式成人儿童剪发器电动剃头刀家用",
                    "coupon_info":"满188元减5元",
                    "shop_title":"奥克斯品胜专卖店",
                    "category":1,
                    "num_iid":"1",
                    "coupon_remain_count":3395,
                    "zk_final_price":"269.00",
                    "coupon_start_time":"2016-09-05",
                    "nick":"奥克斯品胜专卖店",
                    "seller_id":2884767143,
                    "volume":76927,
                    "coupon_end_time":"2016-10-01",
                    "coupon_click_url":"https:\/\/uland.taobao.com\/coupon\/edetail?e=8Iirp0qvW4t9%2BIHBh%2BrOiioPr%2BRaKTNCdUZfqAaohJnOVyPi0MUz8w13gui0W49o5PdvjO4eOnOie%2FpBy9wBFg%3D%3D&pid=mm_0_0_0&af=1&itemId=531940770655",
                    "pict_url":"http:\/\/img03.daily.taobao.net\/tfscom\/i1\/TB1XTOqKXXXXXaSXVXXXXXXXXXX_!!0-item_pic.jpg",
                    "item_url":"http:\/\/h5.m.taobao.com\/awp\/core\/detail.htm?id=531940770655",
                    "input_num_iid":"1",
                    "annual_vol":"1万+"
                }
            ]
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码	错误描述	解决方案
isp.tbkapi-service-unavailable	淘宝客API服务不可用	请稍后重试
isv.invalid-parameter:start_price	参数填写不正确	参数填写不正确
isv.invalid-parameter:end_price	参数填写不正确	参数填写不正确
isv.invalid-parameter:end_tk_rate	参数填写不正确	参数填写不正确
35	您输入的商品ID不合法，请使用升级后的新商品ID，如有疑问请加入【淘宝联盟】线上合规升级咨询群（钉钉群：44965410）进行咨询	您输入的商品ID不合法，请使用升级后的新商品ID，如有疑问请加入【淘宝联盟】线上合规升级咨询群（钉钉群：44965410）进行咨询
37	ID处理异常	ID处理异常
4	查询不到宝贝	查询不到宝贝

API测试工具错误码查询工具 SDK下载

开放平台

淘宝客API

taobao.tbk.itemid.coupon.get (淘宝客-推广者-根据宝贝id批量查询优惠券)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ