阿里大于 -

请求地址：

环境	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_query_dto	CouponOrderQueryDto	必须			查询对象
└ biz_order_id String 必须 629342 本地生活订单号

名称	类型	示例值	描述
data	CouponOrderVoucherDto	{}	订单对象
└ biz_order_id String 9872394892 本地生活订单号 voucher_list CouponOrderVoucherDetailDto [] [] 凭证列表 └ item_id String 3902233 商品ID └ title String 测试商品名称商品名称 └ voucher_id String 23324923 凭证ID └ voucher_status String USED 凭证状态。可用EFFECTIVE、已用USED、失效CANCELED └ total_amount Number 1 总份数 └ used_amount Number 1 已使用份数 └ refund_amount Number 0 已退款份数（售中、售后） └ effect_time Date 2021-11-24 12:15:20 凭证生效时间 └ expire_time Date 2021-11-28 12:15:20 凭证过期时间 └ ext_info String {} 扩展字段 └ before_use_refund_amount Number 1 售中退数量 └ after_use_refund_amount Number 1 售后退数量 └ refund_type String BEFORE_USE_REFUND 凭证退款类型。售中退BEFORE_USE_REFUND、售后退AFTER_USE_REFUND、过期退EXPIRATION_REFUND、冲正REVERSE └ order_status String PAID 订单状态。当前只有PAID一个状态
result_code	Number	1	错误码
message	String	success	如果有错误，对应错误原因

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscUnionElemeCouponOrderQueryRequest req = new AlibabaAlscUnionElemeCouponOrderQueryRequest();
AlibabaAlscUnionElemeCouponOrderQueryRequest.CouponOrderQueryDto obj1 = new AlibabaAlscUnionElemeCouponOrderQueryRequest.CouponOrderQueryDto();
obj1.setBizOrderId("629342");
req.setOrderQueryDto(obj1);
AlibabaAlscUnionElemeCouponOrderQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscUnionElemeCouponOrderQueryRequest req = new AlibabaAlscUnionElemeCouponOrderQueryRequest();
AlibabaAlscUnionElemeCouponOrderQueryRequest.CouponOrderQueryDtoDomain obj1 = new AlibabaAlscUnionElemeCouponOrderQueryRequest.CouponOrderQueryDtoDomain();
obj1.BizOrderId = "629342";
req.OrderQueryDto_ = obj1;
AlibabaAlscUnionElemeCouponOrderQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscUnionElemeCouponOrderQueryRequest;
$order_query_dto = new CouponOrderQueryDto;
$order_query_dto->biz_order_id="629342";
$req->setOrderQueryDto(json_encode($order_query_dto));
$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.alsc.union.eleme.coupon.order.query' \
-d 'partner_id=apidoc' \
-d 'session=685d123e-850e-4dd4-8bf1-885a2d8aed00' \
-d 'sign=516D65E7EB51C126FC24B156193FAE61' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-15+15%3A42%3A51' \
-d 'v=2.0' \
-d 'order_query_dto=%7B%7D'

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

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

req.order_query_dto="{}"
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.alsc.union.eleme.coupon.order.query");
add_param(pRequest,"order_query_dto","数据结构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.alsc.union.eleme.coupon.order.query', {
	'order_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_union_eleme_coupon_order_query_response>
    <data>
        <biz_order_id>9872394892</biz_order_id>
        <voucher_list>
            <coupon_order_voucher_detail_dto>
                <item_id>3902233</item_id>
                <title>测试商品名称</title>
                <voucher_id>23324923</voucher_id>
                <voucher_status>USED</voucher_status>
                <total_amount>1</total_amount>
                <used_amount>1</used_amount>
                <refund_amount>0</refund_amount>
                <effect_time>2021-11-24 12:15:20</effect_time>
                <expire_time>2021-11-28 12:15:20</expire_time>
                <ext_info>{}</ext_info>
                <before_use_refund_amount>1</before_use_refund_amount>
                <after_use_refund_amount>1</after_use_refund_amount>
                <refund_type>BEFORE_USE_REFUND</refund_type>
            </coupon_order_voucher_detail_dto>
        </voucher_list>
        <order_status>PAID</order_status>
    </data>
    <result_code>1</result_code>
    <message>success</message>
</alibaba_alsc_union_eleme_coupon_order_query_response>

{
    "alibaba_alsc_union_eleme_coupon_order_query_response":{
        "data":{
            "biz_order_id":"9872394892",
            "voucher_list":{
                "coupon_order_voucher_detail_dto":[
                    {
                        "item_id":"3902233",
                        "title":"测试商品名称",
                        "voucher_id":"23324923",
                        "voucher_status":"USED",
                        "total_amount":1,
                        "used_amount":1,
                        "refund_amount":0,
                        "effect_time":"2021-11-24 12:15:20",
                        "expire_time":"2021-11-28 12:15:20",
                        "ext_info":"{}",
                        "before_use_refund_amount":1,
                        "after_use_refund_amount":1,
                        "refund_type":"BEFORE_USE_REFUND"
                    }
                ]
            },
            "order_status":"PAID"
        },
        "result_code":1,
        "message":"success"
    }
}

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.alsc.union.eleme.coupon.order.query (饿了么卡券openapi订单查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ