淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
params	OrderDO	必须			参数对象
└ card_type String 可选大润发会员卡会员卡别 └ card_no String 可选 10125052708 会员卡号 └ store_code String 必须 CSDRF01001 经营店编码 item_list ItemDO [] 必须订单商品列表 └ item_code String 必须 1977873 商品货号 └ unit String 可选包标品单位 └ quantity Number 可选 1 标品购买数量 └ inv_unit String 可选包库存单位(非标品使用) └ inv_quantity String 可选 2.0 库存单位购买数量(非标品使用) └ pay_amt Number 必须 1000 折扣后金额（分） └ order_id String 可选 124354346546 订单号 └ attribute String 可选 {"channel_code": "darunfa", "pos_code": "0001"} 附加信息，json对象(key-value): channel_code:收银机渠道号，如：大润发换购POS-darunfa pos_code:收银通道号

名称	类型	示例值	描述
errCode	String	SUCCESS	错误码
errMessage	String	成功	错误信息
success	Boolean	true	true:成功 false:失败
extraRights	RightsDO []		额外权益列表
└ type Number 2 权益类型，1-列印 2-停车券 └ content String [{"type":1, "content": [{"content":["恭喜您获得29次1元换购机会"],"locate": "left","size":"1","type":"text"},{"content":["2018年至昨日累计消费760.78元，可参加超值换购活动"],"locate":"left","size":"1","type":"text"},{"content":[ "您可获得47个集点 "],"locate":"left","size":"1","type":"text"}]}] 小票定制小票样式内容以JsonArray的形式传输至POS客户端。Array中的每个元素代表小票上的一行内容，并约定内容格式如下： [{ "locate":"left/right/center/leftAndRight", "type":"text/qrcode/barcode/logo", "size":"1-8", "content":[ "str param1", "str param2", "...", ] } ] 格式说明 locate(位置): left-内容居左 right-内容居右 center-内容居中 leftAndRight-内容左右对齐 type(类型): text-文本 qrcode-二维码 barcode-条形码 logo-商家logo图片 size(字体大小):1-8 content(内容,数组):param1-barcode/qrcode/text的文本内容 param2-右侧文本内容（type=text, locate=leftAndRight情况下）

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaWdkPosOrderExtraRightsQueryRequest req = new AlibabaWdkPosOrderExtraRightsQueryRequest();
AlibabaWdkPosOrderExtraRightsQueryRequest.OrderDO obj1 = new AlibabaWdkPosOrderExtraRightsQueryRequest.OrderDO();
obj1.setCardType("大润发会员卡");
obj1.setCardNo("10125052708");
obj1.setStoreCode("CSDRF01001");
List<AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDO> list3 = new ArrayList<AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDO>();
AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDO obj4 = new AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDO();
list3.add(obj4);
obj4.setItemCode("1977873");
obj4.setUnit("包");
obj4.setQuantity(1L);
obj4.setInvUnit("包");
obj4.setInvQuantity("2.0");
obj4.setPayAmt(1000L);
obj1.setItemList(list3);
obj1.setOrderId("124354346546");
obj1.setAttribute("{\"channel_code\": \"darunfa\", \"pos_code\": \"0001\"}");
req.setParams(obj1);
AlibabaWdkPosOrderExtraRightsQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaWdkPosOrderExtraRightsQueryRequest req = new AlibabaWdkPosOrderExtraRightsQueryRequest();
AlibabaWdkPosOrderExtraRightsQueryRequest.OrderDODomain obj1 = new AlibabaWdkPosOrderExtraRightsQueryRequest.OrderDODomain();
obj1.CardType = "大润发会员卡";
obj1.CardNo = "10125052708";
obj1.StoreCode = "CSDRF01001";
List<AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDODomain> list3 = new List<AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDODomain>();
AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDODomain obj4 = new AlibabaWdkPosOrderExtraRightsQueryRequest.ItemDODomain();
list3.Add(obj4);
obj4.ItemCode = "1977873";
obj4.Unit = "包";
obj4.Quantity = 1L;
obj4.InvUnit = "包";
obj4.InvQuantity = "2.0";
obj4.PayAmt = 1000L;
obj1.ItemList= list3;
obj1.OrderId = "124354346546";
obj1.Attribute = "{\"channel_code\": \"darunfa\", \"pos_code\": \"0001\"}";
req.Params_ = obj1;
AlibabaWdkPosOrderExtraRightsQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaWdkPosOrderExtraRightsQueryRequest;
$params = new OrderDO;
$params->card_type="大润发会员卡";
$params->card_no="10125052708";
$params->store_code="CSDRF01001";
$item_list = new ItemDO;
$item_list->item_code="1977873";
$item_list->unit="包";
$item_list->quantity="1";
$item_list->inv_unit="包";
$item_list->inv_quantity="2.0";
$item_list->pay_amt="1000";
$params->item_list = $item_list;
$params->order_id="124354346546";
$params->attribute="{\"channel_code\": \"darunfa\", \"pos_code\": \"0001\"}";
$req->setParams(json_encode($params));
$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=qimen.alibaba.wdk.pos.order.extra.rights.query' \
-d 'partner_id=apidoc' \
-d 'sign=0E64D85CAD6AA19DAA435EEC3FF69EA5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+18%3A13%3A00' \
-d 'v=2.0' \
-d 'params=%7B+++%5C%22store_code%5C%22%3A+11734567%2C+++%5C%22card_type%5C%22%3A+1%2C+++%5C%22item_list%5C%22%3A+%7B+++++%5C%22pay_amt%5C%22%3A+1000%2C+++++%5C%22inv_quantity%5C%22%3A+%5C%222.0%5C%22%2C+++++%5C%22inv_unit%5C%22%3A+%5C%22kg%5C%22%2C+++++%5C%22unit%5C%22%3A+%5C%22%E4%BB%BD%5C%22%2C+++++%5C%22item_code%5C%22%3A+%5C%2223457657%5C%22%2C+++++%5C%22quantity%5C%22%3A+1+++%7D%2C+++%5C%22client_no%5C%22%3A+12345678+%7D'

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

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

req.params="{   \"store_code\": 11734567,   \"card_type\": 1,   \"item_list\": {     \"pay_amt\": 1000,     \"inv_quantity\": \"2.0\",     \"inv_unit\": \"kg\",     \"unit\": \"份\",     \"item_code\": \"23457657\",     \"quantity\": 1   },   \"client_no\": 12345678 }"
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,"qimen.alibaba.wdk.pos.order.extra.rights.query");
add_param(pRequest,"params","数据结构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('qimen.alibaba.wdk.pos.order.extra.rights.query', {
	'params':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<errCode>SUCCESS</errCode>
<errMessage>成功</errMessage>
<success>true</success>
<extraRights>
    <rights_d_o>
        <type>2</type>
        <content>[{&quot;type&quot;:1, &quot;content&quot;: [{&quot;content&quot;:[&quot;恭喜您获得29次1元换购机会&quot;],&quot;locate&quot;:   &quot;left&quot;,&quot;size&quot;:&quot;1&quot;,&quot;type&quot;:&quot;text&quot;},{&quot;content&quot;:[&quot;2018年至昨日累计消费760.78元，可参加超值换购活动&quot;],&quot;locate&quot;:&quot;left&quot;,&quot;size&quot;:&quot;1&quot;,&quot;type&quot;:&quot;text&quot;},{&quot;content&quot;:[   &quot;您可获得47个集点   &quot;],&quot;locate&quot;:&quot;left&quot;,&quot;size&quot;:&quot;1&quot;,&quot;type&quot;:&quot;text&quot;}]}]</content>
    </rights_d_o>
</extraRights>

{
    "errCode":"SUCCESS",
    "errMessage":"成功",
    "success":true,
    "extraRights":{
        "rights_d_o":[
            {
                "type":2,
                "content":"[{\"type\":1, \"content\": [{\"content\":[\"恭喜您获得29次1元换购机会\"],\"locate\":   \"left\",\"size\":\"1\",\"type\":\"text\"},{\"content\":[\"2018年至昨日累计消费760.78元，可参加超值换购活动\"],\"locate\":\"left\",\"size\":\"1\",\"type\":\"text\"},{\"content\":[   \"您可获得47个集点   \"],\"locate\":\"left\",\"size\":\"1\",\"type\":\"text\"}]}]"
            }
        ]
    }
}

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

qimen.alibaba.wdk.pos.order.extra.rights.query (根据订单商品明细查询商家额外促销活动)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ