淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
order_id	Number	必须	123456		淘宝订单ID

名称	类型	示例值	描述
order_id	Number	123456	淘宝订单id
order_status	Number	1	订单状态：1-等待买家付款；2-等待商家接单；4-退款中；12-商家配送中；20-订单关闭；22-订单关闭；21-交易完成；
serial_no	String	1	单店单日订单唯一序号
create_time	Number	1234567890	订单创建时间
pay_time	Number	1234567890	订单支付时间
shop_id	Number	123456	店铺shopId
store_id	String	abc2123sdfc	店铺storeId
store_name	String	店铺名	店铺名
store_address_poi	String	3028295,12028295	店铺经纬度
total_fee	Number	123	订单总金额
actual_receive_fee	Number	123	实收金额
actual_pay_fee	Number	123	实付金额
promotion_list	OrderPromotionDto []	订单优惠列表	订单优惠列表
└ type Number 1 优惠类型 └ name String 平台红包优惠名称 └ amount Number 100 优惠金额
total_promotion	Number	100	总优惠信息
buyer_name	String	张三	买家收货地址上的名字
buyer_phone	String	13012345678	买家收货地址上的电话
buyer_note	String	买家留言	买家留言
invoice_title	String	发票抬头	发票抬头
buyer_address	String	买家地址	买家地址
buyer_address_poi	String	3028295,12028295	买家收货地址经纬度
is_frequenter	Number	1	该店铺的老顾客
carriage	Number	100	商家设置的运费
sub_order_list	SubOrderDto []	子订单	子订单
└ sub_order_id Number 123456789 子订单ID └ item_id Number 123456 商品ID └ type Number 0 商品营销类型：0-普通，1-满就送；2-兑换券 └ price Number 100 价格 └ buy_amount Number 1 购买数量 └ unit String 盒商品单位 └ title String 商品名称商品名称 └ out_itemd_id String 商家自定义商品ID 商家自定义商品ID └ rx Number 1 是否为处方药
rx	Number	1	处方药标示
rx_phone	String	13012345678	处方药回拨电话
rx_pic_list	String []	处方图片	处方图片
drug_take	Number	1	自提标识
buyer_address_province	String	北京市	收货地址-省
buyer_address_city	String	北京市	收货地址-市
buyer_address_district	String	海淀区	收货地址-区
expected_delivery_time	Date	2018-12-11 10:00:00	预计送达时间
rx_type	String	1	1单轨、2双规、3医保支付、4医保自费
out_store_id	String	123123	高德、本地商户
mi_check_param	String	123,123,123,123,123,123	包含医保结算ID，就诊ID，统筹医保金额，医保个账金额，现金金额，就诊人员编号，退款结算ID（按照字段排列顺序）。支付成功后，退款成功之前有六个字段，退款成功之后该字符串变成七个字段

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthNrTradeOrderGetRequest req = new AlibabaAlihealthNrTradeOrderGetRequest();
req.setOrderId(123456L);
AlibabaAlihealthNrTradeOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthNrTradeOrderGetRequest req = new AlibabaAlihealthNrTradeOrderGetRequest();
req.OrderId = 123456L;
AlibabaAlihealthNrTradeOrderGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthNrTradeOrderGetRequest;
$req->setOrderId("123456");
$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=alibaba.alihealth.nr.trade.order.get' \
-d 'partner_id=apidoc' \
-d 'session=070e192d-c3f5-4847-98bf-bfb305c6cac0' \
-d 'sign=743C537D2AD5DEF49FE9FEE557B8145E' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+20%3A19%3A14' \
-d 'v=2.0' \
-d 'order_id=123456'

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

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

req.order_id=123456
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,"alibaba.alihealth.nr.trade.order.get");
add_param(pRequest,"order_id","123456");
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('alibaba.alihealth.nr.trade.order.get', {
	'order_id':'123456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_nr_trade_order_get_response>
    <order_id>123456</order_id>
    <order_status>1</order_status>
    <serial_no>1</serial_no>
    <create_time>1234567890</create_time>
    <pay_time>1234567890</pay_time>
    <shop_id>123456</shop_id>
    <store_id>abc2123sdfc</store_id>
    <store_name>店铺名</store_name>
    <store_address_poi>3028295,12028295</store_address_poi>
    <total_fee>123</total_fee>
    <actual_receive_fee>123</actual_receive_fee>
    <actual_pay_fee>123</actual_pay_fee>
    <promotion_list>
        <order_promotion_dto>
            <type>1</type>
            <name>平台红包</name>
            <amount>100</amount>
        </order_promotion_dto>
    </promotion_list>
    <total_promotion>100</total_promotion>
    <buyer_name>张三</buyer_name>
    <buyer_phone>13012345678</buyer_phone>
    <buyer_note>买家留言</buyer_note>
    <invoice_title>发票抬头</invoice_title>
    <buyer_address>买家地址</buyer_address>
    <buyer_address_poi>3028295,12028295</buyer_address_poi>
    <is_frequenter>1</is_frequenter>
    <carriage>100</carriage>
    <sub_order_list>
        <sub_order_dto>
            <sub_order_id>123456789</sub_order_id>
            <item_id>123456</item_id>
            <type>0</type>
            <price>100</price>
            <buy_amount>1</buy_amount>
            <unit>盒</unit>
            <title>商品名称</title>
            <out_itemd_id>商家自定义商品ID</out_itemd_id>
            <rx>1</rx>
        </sub_order_dto>
    </sub_order_list>
    <rx>1</rx>
    <rx_phone>13012345678</rx_phone>
    <rx_pic_list>
        <string>处方图片</string>
    </rx_pic_list>
    <drug_take>1</drug_take>
    <buyer_address_province>北京市</buyer_address_province>
    <buyer_address_city>北京市</buyer_address_city>
    <buyer_address_district>海淀区</buyer_address_district>
    <expected_delivery_time>2018-12-11 10:00:00</expected_delivery_time>
    <rx_type>1</rx_type>
    <out_store_id>123123</out_store_id>
    <mi_check_param>123,123,123,123,123,123</mi_check_param>
</alibaba_alihealth_nr_trade_order_get_response>

{
    "alibaba_alihealth_nr_trade_order_get_response":{
        "order_id":123456,
        "order_status":1,
        "serial_no":"1",
        "create_time":1234567890,
        "pay_time":1234567890,
        "shop_id":123456,
        "store_id":"abc2123sdfc",
        "store_name":"店铺名",
        "store_address_poi":"3028295,12028295",
        "total_fee":123,
        "actual_receive_fee":123,
        "actual_pay_fee":123,
        "promotion_list":{
            "order_promotion_dto":[
                {
                    "type":1,
                    "name":"平台红包",
                    "amount":100
                }
            ]
        },
        "total_promotion":100,
        "buyer_name":"张三",
        "buyer_phone":"13012345678",
        "buyer_note":"买家留言",
        "invoice_title":"发票抬头",
        "buyer_address":"买家地址",
        "buyer_address_poi":"3028295,12028295",
        "is_frequenter":1,
        "carriage":100,
        "sub_order_list":{
            "sub_order_dto":[
                {
                    "sub_order_id":123456789,
                    "item_id":123456,
                    "type":0,
                    "price":100,
                    "buy_amount":1,
                    "unit":"盒",
                    "title":"商品名称",
                    "out_itemd_id":"商家自定义商品ID",
                    "rx":1
                }
            ]
        },
        "rx":1,
        "rx_phone":"13012345678",
        "rx_pic_list":{
            "string":[
                "处方图片"
            ]
        },
        "drug_take":1,
        "buyer_address_province":"北京市",
        "buyer_address_city":"北京市",
        "buyer_address_district":"海淀区",
        "expected_delivery_time":"2018-12-11 10:00:00",
        "rx_type":"1",
        "out_store_id":"123123",
        "mi_check_param":"123,123,123,123,123,123"
    }
}

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"
	}
}

错误码	错误描述	解决方案
NO_PRIVILEGE	没有权限调用此接口	请检查： 1. 是否登录； 2. 账号是否授权访问此接口； 3. 账号是否授权访问此业务；

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

开放平台

阿里健康药API

alibaba.alihealth.nr.trade.order.get (获取订单详情)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ