淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param_order_can_use_rights_req	OrderCanUseRightsReq	可选			入参
goods_list CommodGoodsDataDo [] 可选商品列表 └ actual_amount String 必须 11 实际支付金额 └ amount String 必须 11 商品总金额 └ com_code String 必须 11 商品编码 └ com_dept String 可选 11 部门编码写死11 └ com_store String 必须 11 商品所属门店编码 └ counter_code String 必须 11 专柜编码 └ counts String 必须 11 数量 └ row_no String 必须 11 商品行号 └ cash_actual_amount String 必须 11 pos端和actualAmount相同 └ pay_store String 必须 11 支付门店 └ seq_no String 必须 11 银泰会员账号 └ trade_no String 必须 11 订单号 └ extend_param String 可选 {"codeType":N,"extendParam":1} 扩展参数：k:v格式，Map的JSon串

名称	类型	示例值	描述
data	Response	true	data
apportion_list ApportionDo [] list 优惠分摊 └ code String 11 code └ coupon_row_no String 11 couponRowNo └ code_amount Number 11234442 codeAmount └ code_type String cash codeType goods_apportion_list ConsumeGoodsApportionDo [] goodsApportionList └ goods_apportion_amount String 26000 goodsApportionAmount └ row_no String 11 rowNo └ com_store String HZ01 comStore └ com_code String 27829283 comCode coupon_d_o_list CouponDo [] 11 券列表 └ code_amount String 2000 codeAmount └ type String 1 type └ checked Boolean true checked └ payment_a String 11 paymentA └ payment_b String 11 paymentB └ coupon_row_no String 11 couponRowNo └ code_name String svx372883 codeName └ code String 11 code └ usable Boolean true 是否可用 └ end_date Date 2017-11-23 12:00:00 endDate └ start_date Date 2017-11-23 12:00:00 startDate selected_coupon_list CouponDo [] ll 选中的券列表 └ code_amount String 38200 codeAmount └ type String 11 type └ checked Boolean true checked └ payment_a String 11 paymentA └ payment_b String 11 paymentB └ coupon_row_no String 11 couponRowNo └ code_name String snhw codeName └ code String 11 code └ usable Boolean false usable └ end_date Date 2017-11-23 12:00:00 endDate └ start_date Date 2017-11-23 12:00:00 startDate └ trade_no String 11 tradeNo

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMjXlifeGetavaliablecouponsRequest req = new AlibabaMjXlifeGetavaliablecouponsRequest();
AlibabaMjXlifeGetavaliablecouponsRequest.OrderCanUseRightsReq obj1 = new AlibabaMjXlifeGetavaliablecouponsRequest.OrderCanUseRightsReq();
List<AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDo> list3 = new ArrayList<AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDo>();
AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDo obj4 = new AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDo();
list3.add(obj4);
obj4.setActualAmount("11");
obj4.setAmount("11");
obj4.setComCode("11");
obj4.setComDept("11");
obj4.setComStore("11");
obj4.setCounterCode("11");
obj4.setCounts("11");
obj4.setRowNo("11");
obj4.setCashActualAmount("11");
obj1.setGoodsList(list3);
obj1.setPayStore("11");
obj1.setSeqNo("11");
obj1.setTradeNo("11");
obj1.setExtendParam("{\"codeType\":N,\"extendParam\":1}");
req.setParamOrderCanUseRightsReq(obj1);
AlibabaMjXlifeGetavaliablecouponsResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMjXlifeGetavaliablecouponsRequest req = new AlibabaMjXlifeGetavaliablecouponsRequest();
AlibabaMjXlifeGetavaliablecouponsRequest.OrderCanUseRightsReqDomain obj1 = new AlibabaMjXlifeGetavaliablecouponsRequest.OrderCanUseRightsReqDomain();
List<AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDoDomain> list3 = new List<AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDoDomain>();
AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDoDomain obj4 = new AlibabaMjXlifeGetavaliablecouponsRequest.CommodGoodsDataDoDomain();
list3.Add(obj4);
obj4.ActualAmount = "11";
obj4.Amount = "11";
obj4.ComCode = "11";
obj4.ComDept = "11";
obj4.ComStore = "11";
obj4.CounterCode = "11";
obj4.Counts = "11";
obj4.RowNo = "11";
obj4.CashActualAmount = "11";
obj1.GoodsList= list3;
obj1.PayStore = "11";
obj1.SeqNo = "11";
obj1.TradeNo = "11";
obj1.ExtendParam = "{\"codeType\":N,\"extendParam\":1}";
req.ParamOrderCanUseRightsReq_ = obj1;
AlibabaMjXlifeGetavaliablecouponsResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMjXlifeGetavaliablecouponsRequest;
$param_order_can_use_rights_req = new OrderCanUseRightsReq;
$goods_list = new CommodGoodsDataDo;
$goods_list->actual_amount="11";
$goods_list->amount="11";
$goods_list->com_code="11";
$goods_list->com_dept="11";
$goods_list->com_store="11";
$goods_list->counter_code="11";
$goods_list->counts="11";
$goods_list->row_no="11";
$goods_list->cash_actual_amount="11";
$param_order_can_use_rights_req->goods_list = $goods_list;
$param_order_can_use_rights_req->pay_store="11";
$param_order_can_use_rights_req->seq_no="11";
$param_order_can_use_rights_req->trade_no="11";
$param_order_can_use_rights_req->extend_param="{\"codeType\":N,\"extendParam\":1}";
$req->setParamOrderCanUseRightsReq(json_encode($param_order_can_use_rights_req));
$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.mj.xlife.getavaliablecoupons' \
-d 'partner_id=apidoc' \
-d 'sign=74C21A6843410CB1BA3AB4F0AD42D68F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-25+15%3A53%3A19' \
-d 'v=2.0' \
-d 'param_order_can_use_rights_req=null'

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

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

req.param_order_can_use_rights_req=""
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.mj.xlife.getavaliablecoupons");
add_param(pRequest,"param_order_can_use_rights_req","数据结构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.mj.xlife.getavaliablecoupons', {
	'param_order_can_use_rights_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mj_xlife_getavaliablecoupons_response>
    <data>
        <apportion_list>
            <apportion_do>
                <code>11</code>
                <coupon_row_no>11</coupon_row_no>
                <code_amount>11234442</code_amount>
                <code_type>cash</code_type>
                <goods_apportion_list>
                    <consume_goods_apportion_do>
                        <goods_apportion_amount>26000</goods_apportion_amount>
                        <row_no>11</row_no>
                        <com_store>HZ01</com_store>
                        <com_code>27829283</com_code>
                    </consume_goods_apportion_do>
                </goods_apportion_list>
            </apportion_do>
        </apportion_list>
        <coupon_d_o_list>
            <coupon_do>
                <code_amount>2000</code_amount>
                <type>1</type>
                <checked>true</checked>
                <payment_a>11</payment_a>
                <payment_b>11</payment_b>
                <coupon_row_no>11</coupon_row_no>
                <code_name>svx372883</code_name>
                <code>11</code>
                <usable>true</usable>
                <end_date>2017-11-23 12:00:00</end_date>
                <start_date>2017-11-23 12:00:00</start_date>
            </coupon_do>
        </coupon_d_o_list>
        <selected_coupon_list>
            <coupon_do>
                <code_amount>38200</code_amount>
                <type>11</type>
                <checked>true</checked>
                <payment_a>11</payment_a>
                <payment_b>11</payment_b>
                <coupon_row_no>11</coupon_row_no>
                <code_name>snhw</code_name>
                <code>11</code>
                <usable>false</usable>
                <end_date>2017-11-23 12:00:00</end_date>
                <start_date>2017-11-23 12:00:00</start_date>
            </coupon_do>
        </selected_coupon_list>
        <trade_no>11</trade_no>
    </data>
</alibaba_mj_xlife_getavaliablecoupons_response>

{
    "alibaba_mj_xlife_getavaliablecoupons_response":{
        "data":{
            "apportion_list":{
                "apportion_do":[
                    {
                        "code":"11",
                        "coupon_row_no":"11",
                        "code_amount":11234442,
                        "code_type":"cash",
                        "goods_apportion_list":{
                            "consume_goods_apportion_do":[
                                {
                                    "goods_apportion_amount":"26000",
                                    "row_no":"11",
                                    "com_store":"HZ01",
                                    "com_code":"27829283"
                                }
                            ]
                        }
                    }
                ]
            },
            "coupon_d_o_list":{
                "coupon_do":[
                    {
                        "code_amount":"2000",
                        "type":"1",
                        "checked":true,
                        "payment_a":"11",
                        "payment_b":"11",
                        "coupon_row_no":"11",
                        "code_name":"svx372883",
                        "code":"11",
                        "usable":true,
                        "end_date":"2017-11-23 12:00:00",
                        "start_date":"2017-11-23 12:00:00"
                    }
                ]
            },
            "selected_coupon_list":{
                "coupon_do":[
                    {
                        "code_amount":"38200",
                        "type":"11",
                        "checked":true,
                        "payment_a":"11",
                        "payment_b":"11",
                        "coupon_row_no":"11",
                        "code_name":"snhw",
                        "code":"11",
                        "usable":false,
                        "end_date":"2017-11-23 12:00:00",
                        "start_date":"2017-11-23 12:00:00"
                    }
                ]
            },
            "trade_no":"11"
        }
    }
}

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.mj.xlife.getavaliablecoupons (获取可用券列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ