淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
biz_type	String	可选	GuoGuoSMB	默认值：GuoGuoSMB	提供给合作伙伴使用的商家域业务类型
mobile	String	可选	13817778888		下单操作人的手机号，用作联系，可以不填写
coupon_statuses	String	可选	未使用	默认值：未使用	未使用、使用中、已使用、已过期四种状态，若不填则默认查“未使用”
user_type	Number	可选	0		当商家使用阿里系账号时可用，0淘系账户，1菜鸟账户
user_id	Number	必须	2206607949573		与userType配合使用
page_size	Number	可选	10	默认值：10	每页显示最多优惠券数目
page_index	Number	可选	1	默认值：1	当前页数

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回对象
data PageDto {} 返回对象 └ total_page Number 1 总页码 data_list CouponInfo [] [] 对象 └ amount String 5.00 金额，单位:元 └ status_desc String new 状态描述 └ description String 通用优惠券优惠券描述 └ gmt_create String 1582713853000 发放时间 └ title String 商家5元寄件优惠券优惠券名称 └ invalid_date String 1583251199000 过期时间 └ effective_date String 1582713849000 生效时间 └ coupon_id Number 123 优惠券ID └ page_size Number 101 每页优惠券数目 └ total_count Number 4 优惠券总数 └ current_page Number 1 当前页码 └ success Boolean true 是否操作成功 └ retry Boolean false 是否需要重试 └ status_message String 系统错误错误信息 └ status_code String error 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessCouponsGetRequest req = new CainiaoPickupBusinessCouponsGetRequest();
req.setBizType("GuoGuoSMB");
req.setMobile("13817778888");
req.setCouponStatuses("未使用");
req.setUserType(0L);
req.setUserId(2206607949573L);
req.setPageSize(10L);
req.setPageIndex(1L);
CainiaoPickupBusinessCouponsGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessCouponsGetRequest req = new CainiaoPickupBusinessCouponsGetRequest();
req.BizType = "GuoGuoSMB";
req.Mobile = "13817778888";
req.CouponStatuses = "未使用";
req.UserType = 0L;
req.UserId = 2206607949573L;
req.PageSize = 10L;
req.PageIndex = 1L;
CainiaoPickupBusinessCouponsGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessCouponsGetRequest;
$req->setBizType("GuoGuoSMB");
$req->setMobile("13817778888");
$req->setCouponStatuses("未使用");
$req->setUserType("0");
$req->setUserId("2206607949573");
$req->setPageSize("10");
$req->setPageIndex("1");
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=cainiao.pickup.business.coupons.get' \
-d 'partner_id=apidoc' \
-d 'session=de29a911-32ca-437d-8ad5-19fdde1db9ad' \
-d 'sign=0A56CA8B08E570E29436B8E4FDBB5134' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+00%3A01%3A53' \
-d 'v=2.0' \
-d 'biz_type=GuoGuoSMB' \
-d 'coupon_statuses=%E6%9C%AA%E4%BD%BF%E7%94%A8' \
-d 'mobile=13817778888' \
-d 'page_index=1' \
-d 'page_size=10' \
-d 'user_id=2206607949573' \
-d 'user_type=0'

# -*- coding: utf-8 -*-
import top.api

req=top.api.CainiaoPickupBusinessCouponsGetRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.biz_type="GuoGuoSMB"
req.mobile="13817778888"
req.coupon_statuses="未使用"
req.user_type=0
req.user_id=2206607949573
req.page_size=10
req.page_index=1
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"cainiao.pickup.business.coupons.get");
add_param(pRequest,"biz_type","GuoGuoSMB");
add_param(pRequest,"mobile","13817778888");
add_param(pRequest,"coupon_statuses","未使用");
add_param(pRequest,"user_type","0");
add_param(pRequest,"user_id","2206607949573");
add_param(pRequest,"page_size","10");
add_param(pRequest,"page_index","1");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('cainiao.pickup.business.coupons.get', {
	'biz_type':'GuoGuoSMB',
	'mobile':'13817778888',
	'coupon_statuses':'未使用',
	'user_type':'0',
	'user_id':'2206607949573',
	'page_size':'10',
	'page_index':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_coupons_get_response>
    <result>
        <data>
            <total_page>1</total_page>
            <data_list>
                <coupon_info>
                    <amount>5.00</amount>
                    <status_desc>new</status_desc>
                    <description>通用优惠券</description>
                    <gmt_create>1582713853000</gmt_create>
                    <title>商家5元寄件优惠券</title>
                    <invalid_date>1583251199000</invalid_date>
                    <effective_date>1582713849000</effective_date>
                    <coupon_id>123</coupon_id>
                </coupon_info>
            </data_list>
            <page_size>101</page_size>
            <total_count>4</total_count>
            <current_page>1</current_page>
        </data>
        <success>true</success>
        <retry>false</retry>
        <status_message>系统错误</status_message>
        <status_code>error</status_code>
    </result>
</cainiao_pickup_business_coupons_get_response>

{
    "cainiao_pickup_business_coupons_get_response":{
        "result":{
            "data":{
                "total_page":1,
                "data_list":{
                    "coupon_info":[
                        {
                            "amount":"5.00",
                            "status_desc":"new",
                            "description":"通用优惠券",
                            "gmt_create":"1582713853000",
                            "title":"商家5元寄件优惠券",
                            "invalid_date":"1583251199000",
                            "effective_date":"1582713849000",
                            "coupon_id":123
                        }
                    ]
                },
                "page_size":101,
                "total_count":4,
                "current_page":1
            },
            "success":true,
            "retry":false,
            "status_message":"系统错误",
            "status_code":"error"
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

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

物流API

cainiao.pickup.business.coupons.get (菜鸟商家寄件查看优惠券信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ