淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
nrmop_order_query	NrmopOrderQuery	可选			nrmopOrderQuery
└ nrmop_order_id Number 必须 124 中台订单id

名称	类型	示例值	描述
result	ResponseResult	111111	返回根对象
└ success Boolean true 调用是否成功 └ error_code String 1 返回错误码 └ error_msg String 不存在返回错误信息 result NrmopOrderTopDto 111111 订单信息 └ erp_shop_code String 111111 ERP店铺id └ order_id Number 124 总表订单id └ channel_order_id String 32139283125448483 各个渠道的订单编号 └ channel_name String 测试渠道渠道名称，供前端在页面展示 └ biz_type String baidu 渠道业务名称 └ channel_order_seq Number 1 渠道流水单号 └ nrmop_shop_id Number 01932 中台中nrmop_shop表中的店铺ID └ erp_shop_id String 111111 ERP店铺ID └ nrmop_shop_name String 测试店铺中台中nrmop_shop表中的店铺名称 └ nrmop_shop_addr String 测试地址店铺地址 └ nrmop_shop_longitude Number 11111112 店铺地址经度，高德 └ nrmop_shop_latitude Number 11111133 店铺地址纬度，高德 └ expect_time String 20190101 18:00:00 期望送达时间 └ amt_total String 10 订单总金额，单位：元 └ amt_seller String 9 门店应收金额，单位：元 └ amt_delivery String 1 配送费，单位：元 └ amt_user String 2 用户实付金额，单位：元 └ amt_items String 8 商品总价 └ amt_package String 2 打包费 └ amt_commision String 2 平台佣金 └ amt_refund String 1 退款金额 └ invoice_title String 测试公司发票抬头 └ disc_total String 2 总优惠 └ disc_channel String 1 渠道承担优惠金额 └ disc_seller String 1 商家承担的优惠金额 └ disc_agent String 0 代理商承担的优惠金额 └ disc_delivery String 0 物流商承担的优惠金额 └ delivery_type String 1 配送方式 └ rx Boolean true 是否处方药订单 └ order_status String 1 订单状态；订单状态：0：全部状态、1：待接单、2：已接单、3：配送员未接单、4：配送员已接单、5：配送中、6：已完成、7：已取消、8：申请退款 └ delivery_status String 2 物流状态 └ refund_status String 1 退款状态 └ delivery_name String 配送员配送员姓名 └ delivery_phone String 13711111111 配送员电话 └ meno String 留言信息买家留言不包含发票内容 items NrmopOrderItemDto [] 111111 商品明细 └ out_id String 3464654 外部id └ item_id Number 123 商品id └ item_name String 999感冒灵商品名称 └ item_specs String 15g 商品规格 └ item_count Number 1 商品数量 └ price String 100 商品价格，分为单位 └ stock_count Number 1 库存数量 └ rx Boolean true 处方药标识 └ vendor String 测试厂商生产厂商 └ batch_number String 693849543 生产批号 └ create_time String 20190101 12:00:00 下单时间 └ cancel_type Number 0 订单取消类型（0未取消，默认值；1用户取消；2商家取消；3商家拒单 └ cancel_reason String 111111 订单取消原因 └ finish_time String 20190101 17:00:00 订单完成时间，专门用于完成订单列表 └ merchant_total_fee Number 12 商家应收打包费

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthNrmopOrderQuerybyidRequest req = new AlibabaAlihealthNrmopOrderQuerybyidRequest();
AlibabaAlihealthNrmopOrderQuerybyidRequest.NrmopOrderQuery obj1 = new AlibabaAlihealthNrmopOrderQuerybyidRequest.NrmopOrderQuery();
obj1.setNrmopOrderId(124L);
req.setNrmopOrderQuery(obj1);
AlibabaAlihealthNrmopOrderQuerybyidResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthNrmopOrderQuerybyidRequest req = new AlibabaAlihealthNrmopOrderQuerybyidRequest();
AlibabaAlihealthNrmopOrderQuerybyidRequest.NrmopOrderQueryDomain obj1 = new AlibabaAlihealthNrmopOrderQuerybyidRequest.NrmopOrderQueryDomain();
obj1.NrmopOrderId = 124L;
req.NrmopOrderQuery_ = obj1;
AlibabaAlihealthNrmopOrderQuerybyidResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthNrmopOrderQuerybyidRequest;
$nrmop_order_query = new NrmopOrderQuery;
$nrmop_order_query->nrmop_order_id="124";
$req->setNrmopOrderQuery(json_encode($nrmop_order_query));
$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.nrmop.order.querybyid' \
-d 'partner_id=apidoc' \
-d 'session=96b15335-364e-4655-8abd-3041651f1812' \
-d 'sign=6E6DF2AB8F7464B2895E88444196FAFF' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-05-02+01%3A04%3A01' \
-d 'v=2.0' \
-d 'nrmop_order_query=null'

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

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

req.nrmop_order_query=""
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.nrmop.order.querybyid");
add_param(pRequest,"nrmop_order_query","数据结构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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.alihealth.nrmop.order.querybyid', {
	'nrmop_order_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_nrmop_order_querybyid_response>
    <result>
        <success>true</success>
        <error_code>1</error_code>
        <error_msg>不存在</error_msg>
        <result>
            <erp_shop_code>111111</erp_shop_code>
            <order_id>124</order_id>
            <channel_order_id>32139283125448483</channel_order_id>
            <channel_name>测试渠道</channel_name>
            <biz_type>baidu</biz_type>
            <channel_order_seq>1</channel_order_seq>
            <nrmop_shop_id>01932</nrmop_shop_id>
            <erp_shop_id>111111</erp_shop_id>
            <nrmop_shop_name>测试店铺</nrmop_shop_name>
            <nrmop_shop_addr>测试地址</nrmop_shop_addr>
            <nrmop_shop_longitude>11111112</nrmop_shop_longitude>
            <nrmop_shop_latitude>11111133</nrmop_shop_latitude>
            <expect_time>20190101 18:00:00</expect_time>
            <amt_total>10</amt_total>
            <amt_seller>9</amt_seller>
            <amt_delivery>1</amt_delivery>
            <amt_user>2</amt_user>
            <amt_items>8</amt_items>
            <amt_package>2</amt_package>
            <amt_commision>2</amt_commision>
            <amt_refund>1</amt_refund>
            <invoice_title>测试公司</invoice_title>
            <disc_total>2</disc_total>
            <disc_channel>1</disc_channel>
            <disc_seller>1</disc_seller>
            <disc_agent>0</disc_agent>
            <disc_delivery>0</disc_delivery>
            <delivery_type>1</delivery_type>
            <rx>true</rx>
            <order_status>1</order_status>
            <delivery_status>2</delivery_status>
            <refund_status>1</refund_status>
            <delivery_name>配送员</delivery_name>
            <delivery_phone>13711111111</delivery_phone>
            <meno>留言信息</meno>
            <items>
                <nrmop_order_item_dto>
                    <out_id>3464654</out_id>
                    <item_id>123</item_id>
                    <item_name>999感冒灵</item_name>
                    <item_specs>15g</item_specs>
                    <item_count>1</item_count>
                    <price>100</price>
                    <stock_count>1</stock_count>
                    <rx>true</rx>
                    <vendor>测试厂商</vendor>
                    <batch_number>693849543</batch_number>
                </nrmop_order_item_dto>
            </items>
            <create_time>20190101 12:00:00</create_time>
            <cancel_type>0</cancel_type>
            <cancel_reason>111111</cancel_reason>
            <finish_time>20190101 17:00:00</finish_time>
            <merchant_total_fee>12</merchant_total_fee>
        </result>
    </result>
</alibaba_alihealth_nrmop_order_querybyid_response>

{
    "alibaba_alihealth_nrmop_order_querybyid_response":{
        "result":{
            "success":true,
            "error_code":"1",
            "error_msg":"不存在",
            "result":{
                "erp_shop_code":"111111",
                "order_id":124,
                "channel_order_id":"32139283125448483",
                "channel_name":"测试渠道",
                "biz_type":"baidu",
                "channel_order_seq":1,
                "nrmop_shop_id":01932,
                "erp_shop_id":"111111",
                "nrmop_shop_name":"测试店铺",
                "nrmop_shop_addr":"测试地址",
                "nrmop_shop_longitude":11111112,
                "nrmop_shop_latitude":11111133,
                "expect_time":"20190101 18:00:00",
                "amt_total":"10",
                "amt_seller":"9",
                "amt_delivery":"1",
                "amt_user":"2",
                "amt_items":"8",
                "amt_package":"2",
                "amt_commision":"2",
                "amt_refund":"1",
                "invoice_title":"测试公司",
                "disc_total":"2",
                "disc_channel":"1",
                "disc_seller":"1",
                "disc_agent":"0",
                "disc_delivery":"0",
                "delivery_type":"1",
                "rx":true,
                "order_status":"1",
                "delivery_status":"2",
                "refund_status":"1",
                "delivery_name":"配送员",
                "delivery_phone":"13711111111",
                "meno":"留言信息",
                "items":{
                    "nrmop_order_item_dto":[
                        {
                            "out_id":"3464654",
                            "item_id":123,
                            "item_name":"999感冒灵",
                            "item_specs":"15g",
                            "item_count":1,
                            "price":"100",
                            "stock_count":1,
                            "rx":true,
                            "vendor":"测试厂商",
                            "batch_number":"693849543"
                        }
                    ]
                },
                "create_time":"20190101 12:00:00",
                "cancel_type":0,
                "cancel_reason":"111111",
                "finish_time":"20190101 17:00:00",
                "merchant_total_fee":12
            }
        }
    }
}

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.nrmop.order.querybyid (中台查询单个订单接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ