淘宝开放平台

请求地址：

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

名称	类型	是否必须	描述
external_platform_request	ExternalPlatformRequest	必须	ISV身份入参
└ biz_type String 必须 ISVMerchant 业务类型
order_operation_person	OrderOperationPerson	必须	用户身份
└ mobile String 可选 13817778888 下单操作人的手机号，用作联系，可以不填写
card_query_condition	CardQueryCondition	可选	查询次卡参数
└ page_index Number 可选 1 当前页数 └ page_size Number 可选 10 每页显示最多次卡数目 └ card_status String 可选未生效，使用中，已使用，已过期，新发卡一次仅能查询一个状态

名称	类型	示例值	描述
result	TdOpenServiceResult		返回对象
data PageDTO 返回对象 └ total_page Number 1 总页码 data_list CardInstance [] 对象 └ remain_times Number 2 剩余次数（次卡的属性） └ template_type Number 1 卡类型 └ deducted_value Number 0 已抵扣金额（金额卡属性） └ card_template_code String CC220707556959263145001 模版的Code，下单时需要当作订单参数传递进来 └ status_desc String 使用中状态描述 └ total_deduct_times Number 2 总共可抵扣次数（次卡的属性） └ valid_start_time String 2022-07-07 有效期开始时间,格式:2020-11-11 └ deducted_times Number 0 已抵扣次数（次卡的属性） └ acquire_way Number 2 卡获取方式 1->购买获得 └ acquire_desc String 平台发放卡获取描述，例：2元购买 └ valid_end_time String 2022-07-10 有效期结束时间,格式:2020-11-11 └ remain_value Number 0 剩余金额（金额卡属性） └ card_instance_code String V2207075541482782786054 实例code,唯一标识该实例 └ full_valid_start_time String 2022-07-07 00:00:00 有效期开始时间,格式:2020-11-11 11:11:11 └ acquire_time String 2022-07-07 14:37:01 卡获得时间,格式:2020年11月11日 11:11:11 └ full_valid_end_time String 2022-07-10 23:59:59 有效期结束时间,格式:2020-11-11 11:11:11 └ total_deduct_value Number 0 总共可抵扣金额（金额卡属性） └ status String inUse 状态 └ page_size Number 10 页面大小 └ current_page Number 1 页码 └ total_count Number 1 总条数 └ success Boolean true 是否操作成功 └ status_message String 系统错误错误信息 └ retry Boolean false 是否需要重试 └ status_code String error 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessCardsGetRequest req = new CainiaoPickupBusinessCardsGetRequest();
CainiaoPickupBusinessCardsGetRequest.ExternalPlatformRequest obj1 = new CainiaoPickupBusinessCardsGetRequest.ExternalPlatformRequest();
obj1.setBizType("ISVMerchant");
req.setExternalPlatformRequest(obj1);
CainiaoPickupBusinessCardsGetRequest.OrderOperationPerson obj2 = new CainiaoPickupBusinessCardsGetRequest.OrderOperationPerson();
obj2.setMobile("13817778888");
req.setOrderOperationPerson(obj2);
CainiaoPickupBusinessCardsGetRequest.CardQueryCondition obj3 = new CainiaoPickupBusinessCardsGetRequest.CardQueryCondition();
obj3.setPageIndex(1L);
obj3.setPageSize(10L);
obj3.setCardStatus("未生效，使用中，已使用，已过期，新发卡");
req.setCardQueryCondition(obj3);
CainiaoPickupBusinessCardsGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessCardsGetRequest req = new CainiaoPickupBusinessCardsGetRequest();
CainiaoPickupBusinessCardsGetRequest.ExternalPlatformRequestDomain obj1 = new CainiaoPickupBusinessCardsGetRequest.ExternalPlatformRequestDomain();
obj1.BizType = "ISVMerchant";
req.ExternalPlatformRequest_ = obj1;
CainiaoPickupBusinessCardsGetRequest.OrderOperationPersonDomain obj2 = new CainiaoPickupBusinessCardsGetRequest.OrderOperationPersonDomain();
obj2.Mobile = "13817778888";
req.OrderOperationPerson_ = obj2;
CainiaoPickupBusinessCardsGetRequest.CardQueryConditionDomain obj3 = new CainiaoPickupBusinessCardsGetRequest.CardQueryConditionDomain();
obj3.PageIndex = 1L;
obj3.PageSize = 10L;
obj3.CardStatus = "未生效，使用中，已使用，已过期，新发卡";
req.CardQueryCondition_ = obj3;
CainiaoPickupBusinessCardsGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessCardsGetRequest;
$external_platform_request = new ExternalPlatformRequest;
$external_platform_request->biz_type="ISVMerchant";
$req->setExternalPlatformRequest(json_encode($external_platform_request));
$order_operation_person = new OrderOperationPerson;
$order_operation_person->mobile="13817778888";
$req->setOrderOperationPerson(json_encode($order_operation_person));
$card_query_condition = new CardQueryCondition;
$card_query_condition->page_index="1";
$card_query_condition->page_size="10";
$card_query_condition->card_status="未生效，使用中，已使用，已过期，新发卡";
$req->setCardQueryCondition(json_encode($card_query_condition));
$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.cards.get' \
-d 'partner_id=apidoc' \
-d 'session=d2d5c85c-251d-41fe-979a-38066510eebb' \
-d 'sign=8735926A6C58496BE13CB1DA1A5FFE9B' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-04+16%3A04%3A33' \
-d 'v=2.0' \
-d 'card_query_condition=null' \
-d 'external_platform_request=null' \
-d 'order_operation_person=null'

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

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

req.external_platform_request="数据结构示例JSON格式"
req.order_operation_person="数据结构示例JSON格式"
req.card_query_condition="数据结构示例JSON格式"
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.cards.get");
add_param(pRequest,"external_platform_request","数据结构JSON示例");
add_param(pRequest,"order_operation_person","数据结构JSON示例");
add_param(pRequest,"card_query_condition","数据结构JSON示例");
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.cards.get', {
	'external_platform_request':'数据结构JSON示例',
	'order_operation_person':'数据结构JSON示例',
	'card_query_condition':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_cards_get_response>
    <result>
        <data>
            <total_page>1</total_page>
            <data_list>
                <card_instance>
                    <remain_times>2</remain_times>
                    <template_type>1</template_type>
                    <deducted_value>0</deducted_value>
                    <card_template_code>CC220707556959263145001</card_template_code>
                    <status_desc>使用中</status_desc>
                    <total_deduct_times>2</total_deduct_times>
                    <valid_start_time>2022-07-07</valid_start_time>
                    <deducted_times>0</deducted_times>
                    <acquire_way>2</acquire_way>
                    <acquire_desc>平台发放</acquire_desc>
                    <valid_end_time>2022-07-10</valid_end_time>
                    <remain_value>0</remain_value>
                    <card_instance_code>V2207075541482782786054</card_instance_code>
                    <full_valid_start_time>2022-07-07 00:00:00</full_valid_start_time>
                    <acquire_time>2022-07-07 14:37:01</acquire_time>
                    <full_valid_end_time>2022-07-10 23:59:59</full_valid_end_time>
                    <total_deduct_value>0</total_deduct_value>
                    <status>inUse</status>
                </card_instance>
            </data_list>
            <page_size>10</page_size>
            <current_page>1</current_page>
            <total_count>1</total_count>
        </data>
        <success>true</success>
        <status_message>系统错误</status_message>
        <retry>false</retry>
        <status_code>error</status_code>
    </result>
</cainiao_pickup_business_cards_get_response>

{
    "cainiao_pickup_business_cards_get_response":{
        "result":{
            "data":{
                "total_page":1,
                "data_list":{
                    "card_instance":[
                        {
                            "remain_times":2,
                            "template_type":1,
                            "deducted_value":0,
                            "card_template_code":"CC220707556959263145001",
                            "status_desc":"使用中",
                            "total_deduct_times":2,
                            "valid_start_time":"2022-07-07",
                            "deducted_times":0,
                            "acquire_way":2,
                            "acquire_desc":"平台发放",
                            "valid_end_time":"2022-07-10",
                            "remain_value":0,
                            "card_instance_code":"V2207075541482782786054",
                            "full_valid_start_time":"2022-07-07 00:00:00",
                            "acquire_time":"2022-07-07 14:37:01",
                            "full_valid_end_time":"2022-07-10 23:59:59",
                            "total_deduct_value":0,
                            "status":"inUse"
                        }
                    ]
                },
                "page_size":10,
                "current_page":1,
                "total_count":1
            },
            "success":true,
            "status_message":"系统错误",
            "retry":false,
            "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.cards.get (裹裹商家寄件查看用户次卡信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ