淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param0	NhChannelDetailReq	必须			查询参数对象
└ order_id Number 必须 2 履约单ID

名称	类型	示例值	描述
result	Result		返回结果
└ message String success 信息 └ code String b001-232 错误码 data NhChannelOrderDetailDTO 结果对象 └ order_id Number 123 履约单ID └ tp_order_id Number 1234 淘宝订单ID └ original_amount Number 2323 订单金额，单位：分 └ status Number 10 履约单状态 └ modify_time Number 1232343 状态修改时间，毫秒数 └ finish_time Number 1232432 履约单核销时间，毫秒数 └ trade_code String 1FEAABFEF 核销码 └ dead_line_time Number 12324 核销截止时间 └ trade_code_status Number 10 核销码状态，0-未生成，10-待核销，20-核销中，30-已核销 └ item_id Number 1232 商品ID └ sku_id Number 1234 skuId └ pay_tool String 支付宝支付方式 └ refund_order_id Number 12323 退款单ID └ refund_status Number 10 0-未退款 10-退款中 20-退款成功 30-退款拒绝 40 - 退款关闭（小二介入拒绝退款） └ close_node Number 10 关单节点，10-待付款 20-待确认 30-待核销 40-已核销 └ discount_amount Number 123 订单优惠金额（单位：分） └ trade_code_write_off_start_time Number 12343 核销发起时间（时间戳，毫秒数） └ pay_time Number 124 支付完成时间(时间戳） └ refund_start_time Number 125 退款发起时间（时间戳，毫秒数） └ refund_time Number 125 退款完成时间 └ refund_type Number 0 退款方式，0-系统 1-用户 └ check_customer_status Number 10 确客状态，0-不需要确客 10-待确客 20-确客通过 30-确客不通过 └ check_customer_start_time Number 123 确客发起时间（时间戳，毫秒数） └ check_customer_end_time Number 125 确客结束时间（时间戳，毫秒数） └ check_customer_dead_line_time Number 127 确客截止时间（时间戳，毫秒数） └ check_customer_type Number 0 确客方式,0-系统，1-人工 └ actual_amount Number 10 实际付款金额（单位：分） └ order_create_time Number 10 创单时间 └ check_customer_reject_reason String 10 确客拒绝原因 └ trade_no String 19232323232 履约单号 └ outer_id String abcccde 商家outerId └ extend_info String {} 扩展参数 └ is_success Boolean true 成功标志

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallAlihouseTradeNhchannelOrderdetailRequest req = new TmallAlihouseTradeNhchannelOrderdetailRequest();
TmallAlihouseTradeNhchannelOrderdetailRequest.NhChannelDetailReq obj1 = new TmallAlihouseTradeNhchannelOrderdetailRequest.NhChannelDetailReq();
obj1.setOrderId(2L);
req.setParam0(obj1);
TmallAlihouseTradeNhchannelOrderdetailResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallAlihouseTradeNhchannelOrderdetailRequest req = new TmallAlihouseTradeNhchannelOrderdetailRequest();
TmallAlihouseTradeNhchannelOrderdetailRequest.NhChannelDetailReqDomain obj1 = new TmallAlihouseTradeNhchannelOrderdetailRequest.NhChannelDetailReqDomain();
obj1.OrderId = 2L;
req.Param0_ = obj1;
TmallAlihouseTradeNhchannelOrderdetailResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallAlihouseTradeNhchannelOrderdetailRequest;
$param0 = new NhChannelDetailReq;
$param0->order_id="2";
$req->setParam0(json_encode($param0));
$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=tmall.alihouse.trade.nhchannel.orderdetail' \
-d 'partner_id=apidoc' \
-d 'session=8bde95a7-8144-4e50-a97a-157561980782' \
-d 'sign=45B7E9D397686071402E509AA63BE349' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-23+22%3A36%3A53' \
-d 'v=2.0' \
-d 'param0=null'

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

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

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

XML示例
JSON示例

<tmall_alihouse_trade_nhchannel_orderdetail_response>
    <result>
        <message>success</message>
        <code>b001-232</code>
        <data>
            <order_id>123</order_id>
            <tp_order_id>1234</tp_order_id>
            <original_amount>2323</original_amount>
            <status>10</status>
            <modify_time>1232343</modify_time>
            <finish_time>1232432</finish_time>
            <trade_code>1FEAABFEF</trade_code>
            <dead_line_time>12324</dead_line_time>
            <trade_code_status>10</trade_code_status>
            <item_id>1232</item_id>
            <sku_id>1234</sku_id>
            <pay_tool>支付宝</pay_tool>
            <refund_order_id>12323</refund_order_id>
            <refund_status>10</refund_status>
            <close_node>10</close_node>
            <discount_amount>123</discount_amount>
            <trade_code_write_off_start_time>12343</trade_code_write_off_start_time>
            <pay_time>124</pay_time>
            <refund_start_time>125</refund_start_time>
            <refund_time>125</refund_time>
            <refund_type>0</refund_type>
            <check_customer_status>10</check_customer_status>
            <check_customer_start_time>123</check_customer_start_time>
            <check_customer_end_time>125</check_customer_end_time>
            <check_customer_dead_line_time>127</check_customer_dead_line_time>
            <check_customer_type>0</check_customer_type>
            <actual_amount>10</actual_amount>
            <order_create_time>10</order_create_time>
            <check_customer_reject_reason>10</check_customer_reject_reason>
            <trade_no>19232323232</trade_no>
            <outer_id>abcccde</outer_id>
        </data>
        <extend_info>{}</extend_info>
        <is_success>true</is_success>
    </result>
</tmall_alihouse_trade_nhchannel_orderdetail_response>

{
    "tmall_alihouse_trade_nhchannel_orderdetail_response":{
        "result":{
            "message":"success",
            "code":"b001-232",
            "data":{
                "order_id":123,
                "tp_order_id":1234,
                "original_amount":2323,
                "status":10,
                "modify_time":1232343,
                "finish_time":1232432,
                "trade_code":"1FEAABFEF",
                "dead_line_time":12324,
                "trade_code_status":10,
                "item_id":1232,
                "sku_id":1234,
                "pay_tool":"支付宝",
                "refund_order_id":12323,
                "refund_status":10,
                "close_node":10,
                "discount_amount":123,
                "trade_code_write_off_start_time":12343,
                "pay_time":124,
                "refund_start_time":125,
                "refund_time":125,
                "refund_type":0,
                "check_customer_status":10,
                "check_customer_start_time":123,
                "check_customer_end_time":125,
                "check_customer_dead_line_time":127,
                "check_customer_type":0,
                "actual_amount":10,
                "order_create_time":10,
                "check_customer_reject_reason":"10",
                "trade_no":"19232323232",
                "outer_id":"abcccde"
            },
            "extend_info":"{}",
            "is_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

tmall.alihouse.trade.nhchannel.orderdetail (天猫好房etc查询履约单详情接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ