淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
user_id	String	必须	3031798632	导购员id
order_id	String	必须	109078258777804955	订单号
out_order_id	String	必须	54321	外部订单号

名称	类型	示例值	描述
result	Result		result
model OrderCreateResult 订单详情 └ order_id String 108717674563804955 订单号 └ alipay_order_id String 108717674563804955 支付宝订单号 └ out_order_id String 12348 外部订单号 └ o2o_guide_id Number 3031798632 导购员Id └ o2o_guide_name String 3031798632 导购员昵称 └ o2o_shop_id String 105565032 门店Id └ o2o_shop_name String 105565032 门店名称 └ item_id Number 560540831441 商品Id └ item_title String juhuasuan强预热2阶段测试宝贝请不要拍商品标题 └ sku_id String 0 skuId └ sku_properties_name String “” sku详情 └ contract_price Number 3 合同金额 └ total_fee Number 3 总价 └ voucher_price Number 10000 优惠金额 └ pay_status Number 8 支付状态 subpay_order_list SubPayOrderDetail [] 子支付订单 └ step_no Number 1 阶段号 └ subpay_order_id Number 968772003804955 子支付订单号 └ pay_status Number 1 子订单支付状态 └ pay_type Number 2 支付类型 └ total_fee Number 1 该阶段总金额 └ disburse_status String 1 资金是否到账 └ can_close Boolean true canClose promotion_info PromotionInfo promotionInfo └ promotion_id Number 1111 promotionId └ promotion_amount Number 1000 promotionAmount └ promotion_type Number 0 0-门店优惠券，1-有价优惠券 └ promotion_order_id Number 1111 promotionOrderId └ promotion_buy_amount Number 111 promotionBuyAmount pay_order_serial_infos PayOrderSerialInfo [] payOrderSerialInfos └ pay_serial_no String 1538363939613011008096025771 刷卡流水 └ step_no Number 1 阶段号 └ batch_no Number 1 刷卡批次 └ paid_money Number 10000 支付金额 └ pay_time String 2018-10-08 12:00:00 支付时间 └ sync_time String 2018-10-08 12:00:00 通联同步时间 └ pay_type Number 1 支付类型，1-刷卡，2-支付宝 └ pay_status Number 1 支付状态，0-支付未决，1-成功 └ msg_code String daogoubao.order-query-parameter-error 错误码 └ msg_info String 必选输入参数不能为空错误信息 └ success Boolean false success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaOmniOrderQueryRequest req = new AlibabaOmniOrderQueryRequest();
req.setUserId("3031798632");
req.setOrderId("109078258777804955");
req.setOutOrderId("54321");
AlibabaOmniOrderQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaOmniOrderQueryRequest req = new AlibabaOmniOrderQueryRequest();
req.UserId = "3031798632";
req.OrderId = "109078258777804955";
req.OutOrderId = "54321";
AlibabaOmniOrderQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaOmniOrderQueryRequest;
$req->setUserId("3031798632");
$req->setOrderId("109078258777804955");
$req->setOutOrderId("54321");
$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.omni.order.query' \
-d 'partner_id=apidoc' \
-d 'session=32723d3b-dde8-486e-9012-f9f45ec443d5' \
-d 'sign=9B54CFAD04B6BF2BFF3F18791FDCBDB7' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+08%3A18%3A25' \
-d 'v=2.0' \
-d 'order_id=109078258777804955' \
-d 'out_order_id=54321' \
-d 'user_id=3031798632'

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

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

req.user_id="3031798632"
req.order_id="109078258777804955"
req.out_order_id="54321"
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.omni.order.query");
add_param(pRequest,"user_id","3031798632");
add_param(pRequest,"order_id","109078258777804955");
add_param(pRequest,"out_order_id","54321");
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.omni.order.query', {
	'user_id':'3031798632',
	'order_id':'109078258777804955',
	'out_order_id':'54321'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_omni_order_query_response>
    <result>
        <model>
            <order_id>108717674563804955</order_id>
            <alipay_order_id>108717674563804955</alipay_order_id>
            <out_order_id>12348</out_order_id>
            <o2o_guide_id>3031798632</o2o_guide_id>
            <o2o_guide_name>3031798632</o2o_guide_name>
            <o2o_shop_id>105565032</o2o_shop_id>
            <o2o_shop_name>105565032</o2o_shop_name>
            <item_id>560540831441</item_id>
            <item_title>juhuasuan强预热2阶段测试宝贝请不要拍</item_title>
            <sku_id>0</sku_id>
            <sku_properties_name>“”</sku_properties_name>
            <contract_price>3</contract_price>
            <total_fee>3</total_fee>
            <voucher_price>10000</voucher_price>
            <pay_status>8</pay_status>
            <subpay_order_list>
                <sub_pay_order_detail>
                    <step_no>1</step_no>
                    <subpay_order_id>968772003804955</subpay_order_id>
                    <pay_status>1</pay_status>
                    <pay_type>2</pay_type>
                    <total_fee>1</total_fee>
                    <disburse_status>1</disburse_status>
                </sub_pay_order_detail>
            </subpay_order_list>
            <can_close>true</can_close>
            <promotion_info>
                <promotion_id>1111</promotion_id>
                <promotion_amount>1000</promotion_amount>
                <promotion_type>0</promotion_type>
                <promotion_order_id>1111</promotion_order_id>
                <promotion_buy_amount>111</promotion_buy_amount>
            </promotion_info>
            <pay_order_serial_infos>
                <pay_order_serial_info>
                    <pay_serial_no>1538363939613011008096025771</pay_serial_no>
                    <step_no>1</step_no>
                    <batch_no>1</batch_no>
                    <paid_money>10000</paid_money>
                    <pay_time>2018-10-08 12:00:00</pay_time>
                    <sync_time>2018-10-08 12:00:00</sync_time>
                    <pay_type>1</pay_type>
                    <pay_status>1</pay_status>
                </pay_order_serial_info>
            </pay_order_serial_infos>
        </model>
        <msg_code>daogoubao.order-query-parameter-error</msg_code>
        <msg_info>必选输入参数不能为空</msg_info>
        <success>false</success>
    </result>
</alibaba_omni_order_query_response>

{
    "alibaba_omni_order_query_response":{
        "result":{
            "model":{
                "order_id":"108717674563804955",
                "alipay_order_id":"108717674563804955",
                "out_order_id":"12348",
                "o2o_guide_id":3031798632,
                "o2o_guide_name":"3031798632",
                "o2o_shop_id":"105565032",
                "o2o_shop_name":"105565032",
                "item_id":560540831441,
                "item_title":"juhuasuan强预热2阶段测试宝贝请不要拍",
                "sku_id":"0",
                "sku_properties_name":"“”",
                "contract_price":3,
                "total_fee":3,
                "voucher_price":10000,
                "pay_status":8,
                "subpay_order_list":{
                    "sub_pay_order_detail":[
                        {
                            "step_no":1,
                            "subpay_order_id":968772003804955,
                            "pay_status":1,
                            "pay_type":2,
                            "total_fee":1,
                            "disburse_status":"1"
                        }
                    ]
                },
                "can_close":true,
                "promotion_info":{
                    "promotion_id":1111,
                    "promotion_amount":1000,
                    "promotion_type":0,
                    "promotion_order_id":1111,
                    "promotion_buy_amount":111
                },
                "pay_order_serial_infos":{
                    "pay_order_serial_info":[
                        {
                            "pay_serial_no":"1538363939613011008096025771",
                            "step_no":1,
                            "batch_no":1,
                            "paid_money":10000,
                            "pay_time":"2018-10-08 12:00:00",
                            "sync_time":"2018-10-08 12:00:00",
                            "pay_type":1,
                            "pay_status":1
                        }
                    ]
                }
            },
            "msg_code":"daogoubao.order-query-parameter-error",
            "msg_info":"必选输入参数不能为空",
            "success":false
        }
    }
}

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.omni.order.query (订单查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ