淘宝开放平台 - 文档中心

请求地址：

环境	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	可选			查询对象
└ max_amt String 可选 10 订单最大总金额 └ biz_type Number 可选 1 渠道：1：手淘、2：饿了么、3：百度外卖、4：支付宝、5：京东、6：美团、7：售药机 └ buyer_phone String 可选 12312341234 买家电话 └ page_no Number 可选 1 页码 └ start_time String 可选 2018-01-01 11:11:11 订单创建开始时间 └ min_amt String 可选 1 订单最小总金额 └ buyer_name String 可选 test 买家姓名 └ order_status Number 必须 0 订单状态：0：全部状态、1：待接单、2：已接单、3：配送员未接单、4：配送员已接单、5：配送中、6：已完成、7：已取消、8：申请退款 └ end_time String 可选 2018-01-01 11:11:11 订单创建终止时间 └ page_size Number 可选 20 页面记录数 └ channel_order_id String 可选 12312312312321 渠道订单id └ nrmop_shop_id String 必须 11111 erp店铺编码 └ item_name String 可选 test 商品名称

名称	类型	示例值	描述
result	ResponseResult		查询结果
result PageRequest 结果分页对象 order_list NrmopOrderTopDto [] 查询结果集合 └ disc_total String 1.1 总优惠金额，单位：元 └ disc_channel String 1.1 平台承担的优惠金额，单位：元 └ disc_seller String 1.1 商家承担的优惠金额，单位：元 └ disc_agent String 1.1 代理商承担的优惠金额，单位：元 └ disc_delivery String 1.1 物流商承担的优惠金额，单位：元 └ expect_time String 尽快送达期望送达时间 └ amt_total String 1.1 订单总金额，单位：元 └ amt_seller String 1.1 门店应收金额，单位：元 └ amt_delivery String 1.1 配送费，单位：元 └ amt_user String 1.1 用户实付金额，单位：元 └ order_id Number 12312312321 中台订单号 └ channel_order_id String 123213213 渠道订单号 └ biz_type String o2o 渠道类型：o2o-手淘O2O；ele-饿了么；baidu-百度外卖；meituan-美团；jd-京东；mvm-售药机 └ channel_order_seq Number 12 渠道流水号 └ nrmop_shop_id Number 12321 中台店铺id └ nrmop_shop_name String 测试店铺中台店铺名称 └ nrmop_shop_addr String 测试店铺地址中台店铺地址 └ nrmop_shop_longitude Number 123321 中台店铺经度 └ nrmop_shop_latitude Number 123123 中台店铺纬度 └ delivery_phone String 12312312 配送员电话 └ meno String 尽快送达订单备注 items NrmopOrderItemDto [] 订单商品信息集合 └ out_id String 123213 ERP商品id └ item_id Number 12321321 中台商品id，唯一标识符 └ item_name String 测试商品名称 └ item_specs String 测试规格规格 └ item_count Number 1 数量 └ price String 12 价格，单价 └ stock_count Number 12 库存 └ rx Boolean false 是否处方药 └ batch_number String 12312321 201811234321 └ vendor String 哈尔滨制药六厂哈尔滨制药六厂 └ create_time String 2022-02-02 22:22:22 订单创建时间 └ amt_items String 1.1 商品总价，单位：元 └ amt_package String 1.1 打包费，单位：元 └ amt_commision String 1.1 平台佣金，单位：元 └ amt_refund String 1.1 退款总金额，单位：元 └ invoice_title String ceshi 发票信息 └ rx Boolean false 是否处方药 └ order_status String 2 订单状态，订单状态：1：待接单、2：已接单、3：配送员未接单、4：配送员已接单、5：配送中、6：已完成、7：已取消、8：申请退款 └ delivery_status String 2 物流状态，0未呼物流，默认值；1已呼叫物流，2配送员已接单，3配送中，4已完成，5已取消 └ refund_status String 2 退款状态，0未申请退款，默认值；1已申请退款；2同意退款；3拒绝退款；4已取消退款 └ delivery_name String 测试配送员配送员姓名 └ cancel_type Number 用户取消订单取消类型：1用户取消；2商家取消；3商家拒单 └ cancel_reason String 取消原因订单取消原因 └ erp_shop_code String 12321321 ERP店铺编码 └ merchant_total_fee Number 1.1 商户应收包装费，单位：分 └ total_count Number 20 记录总数 └ total_page Number 2 总页数 └ current_page Number 1 当前页码 └ page_size Number 20 分页大小 └ success Boolean true 请求是否成功 └ error_msg String 测试错误错误信息 └ error_code String ERR001 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthNrmopOrderGetRequest req = new AlibabaAlihealthNrmopOrderGetRequest();
AlibabaAlihealthNrmopOrderGetRequest.NrmopOrderQuery obj1 = new AlibabaAlihealthNrmopOrderGetRequest.NrmopOrderQuery();
obj1.setMaxAmt("10");
obj1.setBizType(1L);
obj1.setBuyerPhone("12312341234");
obj1.setPageNo(1L);
obj1.setStartTime("2018-01-01 11:11:11");
obj1.setMinAmt("1");
obj1.setBuyerName("test");
obj1.setOrderStatus(0L);
obj1.setEndTime("2018-01-01 11:11:11");
obj1.setPageSize(20L);
obj1.setChannelOrderId("12312312312321");
obj1.setNrmopShopId("11111");
obj1.setItemName("test");
req.setNrmopOrderQuery(obj1);
AlibabaAlihealthNrmopOrderGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthNrmopOrderGetRequest req = new AlibabaAlihealthNrmopOrderGetRequest();
AlibabaAlihealthNrmopOrderGetRequest.NrmopOrderQueryDomain obj1 = new AlibabaAlihealthNrmopOrderGetRequest.NrmopOrderQueryDomain();
obj1.MaxAmt = "10";
obj1.BizType = 1L;
obj1.BuyerPhone = "12312341234";
obj1.PageNo = 1L;
obj1.StartTime = "2018-01-01 11:11:11";
obj1.MinAmt = "1";
obj1.BuyerName = "test";
obj1.OrderStatus = 0L;
obj1.EndTime = "2018-01-01 11:11:11";
obj1.PageSize = 20L;
obj1.ChannelOrderId = "12312312312321";
obj1.NrmopShopId = "11111";
obj1.ItemName = "test";
req.NrmopOrderQuery_ = obj1;
AlibabaAlihealthNrmopOrderGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthNrmopOrderGetRequest;
$nrmop_order_query = new NrmopOrderQuery;
$nrmop_order_query->max_amt="10";
$nrmop_order_query->biz_type="1";
$nrmop_order_query->buyer_phone="12312341234";
$nrmop_order_query->page_no="1";
$nrmop_order_query->start_time="2018-01-01 11:11:11";
$nrmop_order_query->min_amt="1";
$nrmop_order_query->buyer_name="test";
$nrmop_order_query->order_status="0";
$nrmop_order_query->end_time="2018-01-01 11:11:11";
$nrmop_order_query->page_size="20";
$nrmop_order_query->channel_order_id="12312312312321";
$nrmop_order_query->nrmop_shop_id="11111";
$nrmop_order_query->item_name="test";
$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.get' \
-d 'partner_id=apidoc' \
-d 'session=da9f963e-26da-4beb-b2ed-43fc7a55feab' \
-d 'sign=7E7A1FF3B5DF77E5724682E19DDFCD03' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+20%3A52%3A40' \
-d 'v=2.0' \
-d 'nrmop_order_query=null'

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

req=top.api.AlibabaAlihealthNrmopOrderGetRequest(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.get");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

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

XML示例
JSON示例

<alibaba_alihealth_nrmop_order_get_response>
    <result>
        <result>
            <order_list>
                <nrmop_order_top_dto>
                    <disc_total>1.1</disc_total>
                    <disc_channel>1.1</disc_channel>
                    <disc_seller>1.1</disc_seller>
                    <disc_agent>1.1</disc_agent>
                    <disc_delivery>1.1</disc_delivery>
                    <expect_time>尽快送达</expect_time>
                    <amt_total>1.1</amt_total>
                    <amt_seller>1.1</amt_seller>
                    <amt_delivery>1.1</amt_delivery>
                    <amt_user>1.1</amt_user>
                    <order_id>12312312321</order_id>
                    <channel_order_id>123213213</channel_order_id>
                    <biz_type>o2o</biz_type>
                    <channel_order_seq>12</channel_order_seq>
                    <nrmop_shop_id>12321</nrmop_shop_id>
                    <nrmop_shop_name>测试店铺</nrmop_shop_name>
                    <nrmop_shop_addr>测试店铺地址</nrmop_shop_addr>
                    <nrmop_shop_longitude>123321</nrmop_shop_longitude>
                    <nrmop_shop_latitude>123123</nrmop_shop_latitude>
                    <delivery_phone>12312312</delivery_phone>
                    <meno>尽快送达</meno>
                    <items>
                        <nrmop_order_item_dto>
                            <out_id>123213</out_id>
                            <item_id>12321321</item_id>
                            <item_name>测试商品</item_name>
                            <item_specs>测试规格</item_specs>
                            <item_count>1</item_count>
                            <price>12</price>
                            <stock_count>12</stock_count>
                            <rx>false</rx>
                            <batch_number>12312321</batch_number>
                            <vendor>哈尔滨制药六厂</vendor>
                        </nrmop_order_item_dto>
                    </items>
                    <create_time>2022-02-02 22:22:22</create_time>
                    <amt_items>1.1</amt_items>
                    <amt_package>1.1</amt_package>
                    <amt_commision>1.1</amt_commision>
                    <amt_refund>1.1</amt_refund>
                    <invoice_title>ceshi</invoice_title>
                    <rx>false</rx>
                    <order_status>2</order_status>
                    <delivery_status>2</delivery_status>
                    <refund_status>2</refund_status>
                    <delivery_name>测试配送员</delivery_name>
                    <cancel_type>用户取消</cancel_type>
                    <cancel_reason>取消原因</cancel_reason>
                    <erp_shop_code>12321321</erp_shop_code>
                    <merchant_total_fee>1.1</merchant_total_fee>
                </nrmop_order_top_dto>
            </order_list>
            <total_count>20</total_count>
            <total_page>2</total_page>
            <current_page>1</current_page>
            <page_size>20</page_size>
        </result>
        <success>true</success>
        <error_msg>测试错误</error_msg>
        <error_code>ERR001</error_code>
    </result>
</alibaba_alihealth_nrmop_order_get_response>

{
    "alibaba_alihealth_nrmop_order_get_response":{
        "result":{
            "result":{
                "order_list":{
                    "nrmop_order_top_dto":[
                        {
                            "disc_total":"1.1",
                            "disc_channel":"1.1",
                            "disc_seller":"1.1",
                            "disc_agent":"1.1",
                            "disc_delivery":"1.1",
                            "expect_time":"尽快送达",
                            "amt_total":"1.1",
                            "amt_seller":"1.1",
                            "amt_delivery":"1.1",
                            "amt_user":"1.1",
                            "order_id":12312312321,
                            "channel_order_id":"123213213",
                            "biz_type":"o2o",
                            "channel_order_seq":12,
                            "nrmop_shop_id":12321,
                            "nrmop_shop_name":"测试店铺",
                            "nrmop_shop_addr":"测试店铺地址",
                            "nrmop_shop_longitude":123321,
                            "nrmop_shop_latitude":123123,
                            "delivery_phone":"12312312",
                            "meno":"尽快送达",
                            "items":{
                                "nrmop_order_item_dto":[
                                    {
                                        "out_id":"123213",
                                        "item_id":12321321,
                                        "item_name":"测试商品",
                                        "item_specs":"测试规格",
                                        "item_count":1,
                                        "price":"12",
                                        "stock_count":12,
                                        "rx":false,
                                        "batch_number":"12312321",
                                        "vendor":"哈尔滨制药六厂"
                                    }
                                ]
                            },
                            "create_time":"2022-02-02 22:22:22",
                            "amt_items":"1.1",
                            "amt_package":"1.1",
                            "amt_commision":"1.1",
                            "amt_refund":"1.1",
                            "invoice_title":"ceshi",
                            "rx":false,
                            "order_status":"2",
                            "delivery_status":"2",
                            "refund_status":"2",
                            "delivery_name":"测试配送员",
                            "cancel_type":用户取消,
                            "cancel_reason":"取消原因",
                            "erp_shop_code":"12321321",
                            "merchant_total_fee":1.1
                        }
                    ]
                },
                "total_count":20,
                "total_page":2,
                "current_page":1,
                "page_size":20
            },
            "success":true,
            "error_msg":"测试错误",
            "error_code":"ERR001"
        }
    }
}

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

alibaba.alihealth.nrmop.order.get (中台订单导出API)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ