淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_export_payment_request	ExportPaymentRequest	可选			{}
└ end_time Number 可选 33333333 账单结束时间的时间戳，单位毫秒 └ guoguo_order_ids Number [] 可选 [123123,345567] 根据裹裹订单ID所对应的账单，优先根据orderId查询，且一次最多查30个(如果此字段不填，则start_time,end_time,page_index,page_size四个参数必填) └ page_index Number 可选 0 分页参数，第一页为0 └ page_size Number 可选 20 每一页返回的记录，默认20，最多20 └ start_time Number 可选 6666666 账单开始时间的时间戳，单位毫秒 └ status String 可选已完成订单支付状态，目前只支持：“待支付”，“已完成” 两个状态(也可填对应英文 WAITING_FOR_PAYING，FINISH)，不填默认查“已完成”订单

名称	类型	示例值	描述
result	TdOpenServiceResult	{}	返回结果
data PageDto {} 返回结果 data_list PaymentExportInfo [] [] 返回结果 └ send_card_value String 100 寄件卡抵扣(元) └ single_package_price String 100 一单服务费(元) └ step_wise_discount_value String 100 阶梯优惠折扣 └ step_wise_discount_fee String 100 阶梯优惠金额(元) └ total_price String 500 总价(元) └ coupon_price String 150 优惠卷金额(元) └ user_remark String 寄件备注备注 └ follow_weight_step_weight String 1 续重重量(千克) └ follow_weight_step_price String 1 续重金额（元） └ first_weight_start_weight String 1 首重重量(千克) └ first_weight_start_price String 1 首重金额（元） └ user_pay_type String 1 结算类型 └ customer_name String 张三的小店商家名称 └ gmt_upload_mail_no_time String 2020-10-10 回单时间 └ actual_got_time String 2020-10-10 揽收时间 └ gmt_create_time String 2020-10-10 下单时间 └ weight String 1000 重量(千克) └ order_total_price String 5 总价（元），与total_price相同 └ receiver_name String 张* 收件人姓名(脱敏后) └ got_code String 1236 揽件码 └ courier_phone String 13817747777 揽件员电话 └ courier_name String 李四揽件员 └ mail_no String 1357924680 运单号 └ order_id String 31357924680 裹裹订单ID └ receiver_address String 浙江省杭州市西湖区*** 收件人地址（脱敏后） └ sender_address String 浙江省杭州市西湖区寄件人地址（脱敏后只展示到省市区） └ cp_code String YUNDA 揽件员所属公司code └ cp_name String 韵达揽件员所属公司名称 └ pay_time String 2020-10-10 支付时间 └ terminal_source String 菜鸟发货平台下单终端 └ entry_source String 淘系订单订单来源类型：淘系订单，录入订单 └ actual_pay_price String 5 本订单实付金额（当本单未核价或未支付时，本字段会返回0，所以为0未必代表本单不需要付钱。所以需考虑订单状态，并与totalPrice-couponPrice的值相比较） └ total_count Number 120 总数量 └ total_page Number 6 总共多少页 └ page_size Number 20 每页数量 └ current_page Number 3 当前页数 └ retry Boolean false 是否需要重试 └ status_code String error 状态值 └ status_message String 系统错误状态描述 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupPaymentorderGetRequest req = new CainiaoPickupPaymentorderGetRequest();
CainiaoPickupPaymentorderGetRequest.ExportPaymentRequest obj1 = new CainiaoPickupPaymentorderGetRequest.ExportPaymentRequest();
obj1.setEndTime(33333333L);
obj1.setGuoguoOrderIds(new Long[] { 123123,345567 };
);
obj1.setPageIndex(0L);
obj1.setPageSize(20L);
obj1.setStartTime(6666666L);
obj1.setStatus("已完成");
req.setParamExportPaymentRequest(obj1);
CainiaoPickupPaymentorderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupPaymentorderGetRequest req = new CainiaoPickupPaymentorderGetRequest();
CainiaoPickupPaymentorderGetRequest.ExportPaymentRequestDomain obj1 = new CainiaoPickupPaymentorderGetRequest.ExportPaymentRequestDomain();
obj1.EndTime = 33333333L;
obj1.GuoguoOrderIds = new long[] { 123123,345567 };
;
obj1.PageIndex = 0L;
obj1.PageSize = 20L;
obj1.StartTime = 6666666L;
obj1.Status = "已完成";
req.ParamExportPaymentRequest_ = obj1;
CainiaoPickupPaymentorderGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupPaymentorderGetRequest;
$param_export_payment_request = new ExportPaymentRequest;
$param_export_payment_request->end_time="33333333";
$param_export_payment_request->guoguo_order_ids="[123123,345567]";
$param_export_payment_request->page_index="0";
$param_export_payment_request->page_size="20";
$param_export_payment_request->start_time="6666666";
$param_export_payment_request->status="已完成";
$req->setParamExportPaymentRequest(json_encode($param_export_payment_request));
$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.paymentorder.get' \
-d 'partner_id=apidoc' \
-d 'session=3f13da9e-db09-4804-85f5-90f5d3c6976f' \
-d 'sign=2A1B6F8AB99039FF43361901EFD19AF8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+18%3A37%3A45' \
-d 'v=2.0' \
-d 'param_export_payment_request=null'

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

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

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

XML示例
JSON示例

<cainiao_pickup_paymentorder_get_response>
    <result>
        <data>
            <data_list>
                <payment_export_info>
                    <send_card_value>100</send_card_value>
                    <single_package_price>100</single_package_price>
                    <step_wise_discount_value>100</step_wise_discount_value>
                    <step_wise_discount_fee>100</step_wise_discount_fee>
                    <total_price>500</total_price>
                    <coupon_price>150</coupon_price>
                    <user_remark>寄件备注</user_remark>
                    <follow_weight_step_weight>1</follow_weight_step_weight>
                    <follow_weight_step_price>1</follow_weight_step_price>
                    <first_weight_start_weight>1</first_weight_start_weight>
                    <first_weight_start_price>1</first_weight_start_price>
                    <user_pay_type>1</user_pay_type>
                    <customer_name>张三的小店</customer_name>
                    <gmt_upload_mail_no_time>2020-10-10</gmt_upload_mail_no_time>
                    <actual_got_time>2020-10-10</actual_got_time>
                    <gmt_create_time>2020-10-10</gmt_create_time>
                    <weight>1000</weight>
                    <order_total_price>5</order_total_price>
                    <receiver_name>张*</receiver_name>
                    <got_code>1236</got_code>
                    <courier_phone>13817747777</courier_phone>
                    <courier_name>李四</courier_name>
                    <mail_no>1357924680</mail_no>
                    <order_id>31357924680</order_id>
                    <receiver_address>浙江省杭州市西湖区***</receiver_address>
                    <sender_address>浙江省杭州市西湖区</sender_address>
                    <cp_code>YUNDA</cp_code>
                    <cp_name>韵达</cp_name>
                    <pay_time>2020-10-10</pay_time>
                    <terminal_source>菜鸟发货平台</terminal_source>
                    <entry_source>淘系订单</entry_source>
                    <actual_pay_price>5</actual_pay_price>
                </payment_export_info>
            </data_list>
            <total_count>120</total_count>
            <total_page>6</total_page>
            <page_size>20</page_size>
            <current_page>3</current_page>
        </data>
        <retry>false</retry>
        <status_code>error</status_code>
        <status_message>系统错误</status_message>
        <success>true</success>
    </result>
</cainiao_pickup_paymentorder_get_response>

{
    "cainiao_pickup_paymentorder_get_response":{
        "result":{
            "data":{
                "data_list":{
                    "payment_export_info":[
                        {
                            "send_card_value":"100",
                            "single_package_price":"100",
                            "step_wise_discount_value":"100",
                            "step_wise_discount_fee":"100",
                            "total_price":"500",
                            "coupon_price":"150",
                            "user_remark":"寄件备注",
                            "follow_weight_step_weight":"1",
                            "follow_weight_step_price":"1",
                            "first_weight_start_weight":"1",
                            "first_weight_start_price":"1",
                            "user_pay_type":"1",
                            "customer_name":"张三的小店",
                            "gmt_upload_mail_no_time":"2020-10-10",
                            "actual_got_time":"2020-10-10",
                            "gmt_create_time":"2020-10-10",
                            "weight":"1000",
                            "order_total_price":"5",
                            "receiver_name":"张*",
                            "got_code":"1236",
                            "courier_phone":"13817747777",
                            "courier_name":"李四",
                            "mail_no":"1357924680",
                            "order_id":"31357924680",
                            "receiver_address":"浙江省杭州市西湖区***",
                            "sender_address":"浙江省杭州市西湖区",
                            "cp_code":"YUNDA",
                            "cp_name":"韵达",
                            "pay_time":"2020-10-10",
                            "terminal_source":"菜鸟发货平台",
                            "entry_source":"淘系订单",
                            "actual_pay_price":"5"
                        }
                    ]
                },
                "total_count":120,
                "total_page":6,
                "page_size":20,
                "current_page":3
            },
            "retry":false,
            "status_code":"error",
            "status_message":"系统错误",
            "success":true
        }
    }
}

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.paymentorder.get (商家寄件账单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ