淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
miniapp_id	Number	必须	2342342	小程序appid
out_order_id	String	可选	23424	外部三方订单号（与order_id不能同时为空，优先取order_id）
order_id	Number	可选	324432	交易订单号（与out_order_id不能同时为空，优先取order_id）

名称	类型	示例值	描述
successful	Boolean	true	true or false
error_type	Number	1	错误码
model	OrderDTO		返回内容
└ additional_remarks String 加项订单附加说明（如运费、手续费。。。） └ close_order_time Date 2021-12-22 11:58:53 订单关闭时间 └ miniapp_id Number 3000000003953611 小程序appid └ additional_price Number 0 订单附加金额（如运费、手续费。。。） └ modified_time Date 2021-12-22 11:58:53 订单修改时间 └ pay_time Date 2021-12-22 11:58:53 支付时间 └ order_id Number 2355135770005328400 订单id └ open_id String 221284823243242 买家id └ ext String 扩展信息key-value └ path String /path/path 小程序订单详情相对路径 └ discounted_price Number 0 折扣价格 └ create_time Date 2021-12-22 11:58:53 创单时间 └ out_order_id String 12344786199 外部订单id item_list OrderItemDTO [] 订单中商品list └ out_item_id String 444444445 外部商品id └ item_id Number 100000000 商品id └ amount Number 1 数量 └ item_name String 测试商品1 商品测试数量 └ sub_order_id Number 2355135770005328400 子订单id，后续逆向有用 └ sale_price Number 1 售卖价。原价 └ item_path String /path/path 商品相对地址 └ out_sku_id String 32342342 外部SKU id └ item_main_pic String https:////img.alicdn.com/imgextra/i1/373295773/O1CN01SFNBGj1sW52wl8r7I_!!0-item_pic.jpg 商品主图 └ sku_id Number 3234255 sku id └ real_price Number 1 实际成交价格。后续逆向根据这个字段来退款 └ order_price Number 1 订单金额 pay_info PayInfoDTO 支付信息 └ total_fee Number 1 支付金额。和order_price一样 └ out_pay_id String 332342345 外部支付单id └ title String 测试商品1 等支付单标题 └ status Number 100 订单状态
error_msg	String	错误信息	错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
MiniappTradeOrderDetailQueryRequest req = new MiniappTradeOrderDetailQueryRequest();
req.setMiniappId(2342342L);
req.setOutOrderId("23424");
req.setOrderId(324432L);
MiniappTradeOrderDetailQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
MiniappTradeOrderDetailQueryRequest req = new MiniappTradeOrderDetailQueryRequest();
req.MiniappId = 2342342L;
req.OutOrderId = "23424";
req.OrderId = 324432L;
MiniappTradeOrderDetailQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new MiniappTradeOrderDetailQueryRequest;
$req->setMiniappId("2342342");
$req->setOutOrderId("23424");
$req->setOrderId("324432");
$resp = $c->execute($req);

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=taobao.miniapp.trade.order.detail.query' \
-d 'partner_id=apidoc' \
-d 'sign=76CAC5F70341E55FFAAE403F119D4EA3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-03+23%3A17%3A31' \
-d 'v=2.0' \
-d 'miniapp_id=2342342' \
-d 'order_id=324432' \
-d 'out_order_id=23424'

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

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

req.miniapp_id=2342342
req.out_order_id="23424"
req.order_id=324432
try:
	resp= req.getResponse()
	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,"taobao.miniapp.trade.order.detail.query");
add_param(pRequest,"miniapp_id","2342342");
add_param(pRequest,"out_order_id","23424");
add_param(pRequest,"order_id","324432");
pResponse = top_execute(pClient,pRequest,NULL);
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('taobao.miniapp.trade.order.detail.query', {
	'miniapp_id':'2342342',
	'out_order_id':'23424',
	'order_id':'324432'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<miniapp_trade_order_detail_query_response>
    <successful>true</successful>
    <error_type>1</error_type>
    <model>
        <additional_remarks>加项</additional_remarks>
        <close_order_time>2021-12-22 11:58:53</close_order_time>
        <miniapp_id>3000000003953611</miniapp_id>
        <additional_price>0</additional_price>
        <modified_time>2021-12-22 11:58:53</modified_time>
        <pay_time>2021-12-22 11:58:53</pay_time>
        <order_id>2355135770005328400</order_id>
        <open_id>221284823243242</open_id>
        <path>/path/path</path>
        <discounted_price>0</discounted_price>
        <create_time>2021-12-22 11:58:53</create_time>
        <out_order_id>12344786199</out_order_id>
        <item_list>
            <order_item_d_t_o>
                <out_item_id>444444445</out_item_id>
                <item_id>100000000</item_id>
                <amount>1</amount>
                <item_name>测试商品1</item_name>
                <sub_order_id>2355135770005328400</sub_order_id>
                <sale_price>1</sale_price>
                <item_path>/path/path</item_path>
                <out_sku_id>32342342</out_sku_id>
                <item_main_pic>https:////img.alicdn.com/imgextra/i1/373295773/O1CN01SFNBGj1sW52wl8r7I_!!0-item_pic.jpg</item_main_pic>
                <sku_id>3234255</sku_id>
                <real_price>1</real_price>
            </order_item_d_t_o>
        </item_list>
        <order_price>1</order_price>
        <pay_info>
            <total_fee>1</total_fee>
            <out_pay_id>332342345</out_pay_id>
            <title>测试商品1 等</title>
        </pay_info>
        <status>100</status>
    </model>
    <error_msg>错误信息</error_msg>
</miniapp_trade_order_detail_query_response>

{
    "miniapp_trade_order_detail_query_response":{
        "successful":true,
        "error_type":1,
        "model":{
            "additional_remarks":"加项",
            "close_order_time":"2021-12-22 11:58:53",
            "miniapp_id":3000000003953611,
            "additional_price":0,
            "modified_time":"2021-12-22 11:58:53",
            "pay_time":"2021-12-22 11:58:53",
            "order_id":2355135770005328400,
            "open_id":"221284823243242",
            "path":"\/path\/path",
            "discounted_price":0,
            "create_time":"2021-12-22 11:58:53",
            "out_order_id":"12344786199",
            "item_list":{
                "order_item_d_t_o":[
                    {
                        "out_item_id":"444444445",
                        "item_id":100000000,
                        "amount":1,
                        "item_name":"测试商品1",
                        "sub_order_id":2355135770005328400,
                        "sale_price":1,
                        "item_path":"\/path\/path",
                        "out_sku_id":"32342342",
                        "item_main_pic":"https:\/\/\/\/img.alicdn.com\/imgextra\/i1\/373295773\/O1CN01SFNBGj1sW52wl8r7I_!!0-item_pic.jpg",
                        "sku_id":3234255,
                        "real_price":1
                    }
                ]
            },
            "order_price":1,
            "pay_info":{
                "total_fee":1,
                "out_pay_id":"332342345",
                "title":"测试商品1 等"
            },
            "status":100
        },
        "error_msg":"错误信息"
    }
}

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

taobao.miniapp.trade.order.detail.query (轻应用轻交易单个订单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ