淘宝开放平台 - 文档中心

请求地址：

环境	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	GetOrderRequest	必须			入参
└ isv_reservation_record_id String 可选 202110201117ITEM04905620 isv预约记录id └ order_id String 可选 2021123017GORDER11377075187 阿里健康订单id

名称	类型	示例值	描述
result_status	String	FAIL	SUCCESS:成功; FAIL:失败; UNKNOWN:未知;
result_code	String	ORDER_NOT_EXIST	结果码
result_msg	String	订单不存在	结果消息提示
data	OrderInfo		订单信息
└ order_id String 2021122011GORDER11162717656 订单id └ order_creation_time String 2021-12-20 11:17:12 下单时间 └ payment_success_time String 2021-12-20 11:17:12 支付成功时间 order_item_sku_infos OrderItemSkuInfo [] sku信息列表 └ isv_item_sku_id String 61BFE1008811365D75348A81 isv商品skuId └ isv_item_sku_name String VIP体检套餐女 isv商品sku名 └ unit_sales_price BigDecimal 3164.00 单个SKU销售价(元) └ purchase_quantity Number 1 购买数量 └ item_sku_sub_order_id String 202201041432ITEM04752205 商品sku子订单id └ isv_cargo_id String c0099 isv货品id └ total_sales_price BigDecimal 3164.00 总销售价、应付金额(元) └ actual_payment_amount BigDecimal 3164.00 用户实际支付金额(元) └ trade_status String 支付完成交易状态(TO_BE_PAID("待支付"),PAYMENT_COMPLETED("支付完成"),PARTIAL_REFUNDED("部分已退款"),TOTAL_REFUNDED("全部已退款"),CLOSED("交易关闭"),UNKNOWN("未知")) customer_info CustomerInfo 用户信息 └ phone_number String 188****8888 手机号(该字段需要做二次加密，需要通过《服务商开放平台接口对接文档.pdf》第五步进行解密) └ isv_store_id String 1108 isv门店id └ store_name String 上海解码上门检测门店名称 └ isv_supplier_store_id String lz0006 isv供货商门店id └ to_b_order Boolean true to B 渠道订单 └ channel_id String 2 10 携程；11 去哪儿；12 滴滴；13 东方福利网；15 鸿蒙；31 人民日报；58 滴滴；59 小米 pay_order_info PayOrderInfo 支付信息 └ pay_order_no String 2022080810969177755 最新有效的支付订单号 └ tmall_order Boolean true 是否是天猫订单 tmall_order_info TmallOrderInfo 天猫订单信息 └ tmall_order_id String 3871361090650097935 天猫订单id └ tmall_item_id String 748574101261 天猫商品id └ tmall_sku_id String 5166246105998 天猫skuid

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthMedicalOrderRealtimeGetRequest req = new AlibabaAlihealthMedicalOrderRealtimeGetRequest();
AlibabaAlihealthMedicalOrderRealtimeGetRequest.GetOrderRequest obj1 = new AlibabaAlihealthMedicalOrderRealtimeGetRequest.GetOrderRequest();
obj1.setIsvReservationRecordId("202110201117ITEM04905620");
obj1.setOrderId("2021123017GORDER11377075187");
req.setParam0(obj1);
AlibabaAlihealthMedicalOrderRealtimeGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthMedicalOrderRealtimeGetRequest req = new AlibabaAlihealthMedicalOrderRealtimeGetRequest();
AlibabaAlihealthMedicalOrderRealtimeGetRequest.GetOrderRequestDomain obj1 = new AlibabaAlihealthMedicalOrderRealtimeGetRequest.GetOrderRequestDomain();
obj1.IsvReservationRecordId = "202110201117ITEM04905620";
obj1.OrderId = "2021123017GORDER11377075187";
req.Param0_ = obj1;
AlibabaAlihealthMedicalOrderRealtimeGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthMedicalOrderRealtimeGetRequest;
$param0 = new GetOrderRequest;
$param0->isv_reservation_record_id="202110201117ITEM04905620";
$param0->order_id="2021123017GORDER11377075187";
$req->setParam0(json_encode($param0));
$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=alibaba.alihealth.medical.order.realtime.get' \
-d 'partner_id=apidoc' \
-d 'sign=D5BC3F94C5B48FD966A7A15FFBE9D11C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-10+12%3A04%3A52' \
-d 'v=2.0' \
-d 'param0=null'

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

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

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

XML示例
JSON示例

<alibaba_alihealth_medical_order_realtime_get_response>
    <result_status>FAIL</result_status>
    <result_code>ORDER_NOT_EXIST</result_code>
    <result_msg>订单不存在</result_msg>
    <data>
        <order_id>2021122011GORDER11162717656</order_id>
        <order_creation_time>2021-12-20 11:17:12</order_creation_time>
        <payment_success_time>2021-12-20 11:17:12</payment_success_time>
        <order_item_sku_infos>
            <order_item_sku_info>
                <isv_item_sku_id>61BFE1008811365D75348A81</isv_item_sku_id>
                <isv_item_sku_name>VIP体检套餐女</isv_item_sku_name>
                <unit_sales_price>3164.00</unit_sales_price>
                <purchase_quantity>1</purchase_quantity>
                <item_sku_sub_order_id>202201041432ITEM04752205</item_sku_sub_order_id>
                <isv_cargo_id>c0099</isv_cargo_id>
            </order_item_sku_info>
        </order_item_sku_infos>
        <total_sales_price>3164.00</total_sales_price>
        <actual_payment_amount>3164.00</actual_payment_amount>
        <trade_status>支付完成</trade_status>
        <customer_info>
            <phone_number>188****8888</phone_number>
        </customer_info>
        <isv_store_id>1108</isv_store_id>
        <store_name>上海解码上门检测</store_name>
        <isv_supplier_store_id>lz0006</isv_supplier_store_id>
        <to_b_order>true</to_b_order>
        <channel_id>2</channel_id>
        <pay_order_info>
            <pay_order_no>2022080810969177755</pay_order_no>
        </pay_order_info>
        <tmall_order>true</tmall_order>
        <tmall_order_info>
            <tmall_order_id>3871361090650097935</tmall_order_id>
            <tmall_item_id>748574101261</tmall_item_id>
            <tmall_sku_id>5166246105998</tmall_sku_id>
        </tmall_order_info>
    </data>
</alibaba_alihealth_medical_order_realtime_get_response>

{
    "alibaba_alihealth_medical_order_realtime_get_response":{
        "result_status":"FAIL",
        "result_code":"ORDER_NOT_EXIST",
        "result_msg":"订单不存在",
        "data":{
            "order_id":"2021122011GORDER11162717656",
            "order_creation_time":"2021-12-20 11:17:12",
            "payment_success_time":"2021-12-20 11:17:12",
            "order_item_sku_infos":{
                "order_item_sku_info":[
                    {
                        "isv_item_sku_id":"61BFE1008811365D75348A81",
                        "isv_item_sku_name":"VIP体检套餐女",
                        "unit_sales_price":"3164.00",
                        "purchase_quantity":1,
                        "item_sku_sub_order_id":"202201041432ITEM04752205",
                        "isv_cargo_id":"c0099"
                    }
                ]
            },
            "total_sales_price":"3164.00",
            "actual_payment_amount":"3164.00",
            "trade_status":"支付完成",
            "customer_info":{
                "phone_number":"188****8888"
            },
            "isv_store_id":"1108",
            "store_name":"上海解码上门检测",
            "isv_supplier_store_id":"lz0006",
            "to_b_order":true,
            "channel_id":"2",
            "pay_order_info":{
                "pay_order_no":"2022080810969177755"
            },
            "tmall_order":true,
            "tmall_order_info":{
                "tmall_order_id":"3871361090650097935",
                "tmall_item_id":"748574101261",
                "tmall_sku_id":"5166246105998"
            }
        }
    }
}

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下载

开放平台

阿里健康-本地医疗-通用订单服务

alibaba.alihealth.medical.order.realtime.get (服务商订单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ