淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
storeNo	String	必须	MJ01	在银泰的门店号
memberBarcde	String	可选	18612642933	品牌方会员码
shoppeNo	String	必须	00092	在银泰的专柜编号
serialNo	String	必须	MJ0173774040001	本次算价的唯一编号
singleProductList	String	必须	[{"tagPrice":"3000","unionKey":"1","barcode":"YOGA001","salePrice":2888,"count":2,"skuid":"6155701"}]	在银泰的门店号
selectList	String	必须	[{"promotionUnionKey":"12345678","promotionType":"coupon","value":"0"}]	已选中的所有营销信息
extendParam	String	可选	{"xx","xx"}	扩展参数

名称	类型	示例值	描述
errcode	String	200	业务异常码
isSuccess	Boolean	true	是否成功
model	Model		营销明细
memberInfo MemberInfo 会员信息 └ nickName String Ethan 会员昵称 └ extendsInfoMap String [] 其它扩展信息， key为在页面上显示的名称， value为值。如extendsInfoMap.put("积分","100") └ levelName String 西有灵犀卡会员会员等级名称 └ memberId String 5 会员唯一ID └ notifyMsg String 当前订单可办灵犀卡提醒消息 promotionGroupList PromotionList 具体营销信息 └ isShowSummryInfo Boolean false 当当前分组的概要信息是否需要显示，如分组名和分组金额 └ name String 会员权益分组名称 promotionList PromotionList [] 当前营销分组下的所有营销详情 └ totalAmount String 0 当前类型下的营销金额，当小于等于0时不显示 promotionType PromotionType 营销类型 └ checkedType String UNCHECKED 勾选状态枚举 └ unionKey String R84ddfb34126fc3a48ee38d7044e87276 促销唯一key └ name String 灵犀卡[365] 促销名称 └ isAllowEdit Boolean false 是否允许编辑 └ apportionDetail String [] 营销级别按照商品分摊明细 * key为商品唯一标识 {@link OrderDto.ProductDto#getUnionKey()} },value为分摊金额，单位为元，精确到分 └ totalPromotion String 0 当前类型下的营销金额，当小于等于0时不显示 └ serialNo String MJ0173774040001 本次算价的唯一编号 └ totalPromotion Number 500 总优惠金额
message	String	查询成功	业务异常消息

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

QimenCloudClient client = new DefaultQimenCloudClient(url, appkey, secret);
AlibabaMosBroadingbrandGetRequest req = new AlibabaMosBroadingbrandGetRequest();
req.setStoreNo("MJ01");
req.setMemberBarcde("18612642933");
req.setShoppeNo("00092");
req.setSerialNo("MJ0173774040001");
req.setSingleProductList("[{\"tagPrice\":\"3000\",\"unionKey\":\"1\",\"barcode\":\"YOGA001\",\"salePrice\":2888,\"count\":2,\"skuid\":\"6155701\"}]");
req.setSelectList("[{\"promotionUnionKey\":\"12345678\",\"promotionType\":\"coupon\",\"value\":\"0\"}]");
req.setExtendParam("{\"xx\",\"xx\"}");
AlibabaMosBroadingbrandGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosBroadingbrandGetRequest req = new AlibabaMosBroadingbrandGetRequest();
req.StoreNo = "MJ01";
req.MemberBarcde = "18612642933";
req.ShoppeNo = "00092";
req.SerialNo = "MJ0173774040001";
req.SingleProductList = "[{\"tagPrice\":\"3000\",\"unionKey\":\"1\",\"barcode\":\"YOGA001\",\"salePrice\":2888,\"count\":2,\"skuid\":\"6155701\"}]";
req.SelectList = "[{\"promotionUnionKey\":\"12345678\",\"promotionType\":\"coupon\",\"value\":\"0\"}]";
req.ExtendParam = "{\"xx\",\"xx\"}";
AlibabaMosBroadingbrandGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosBroadingbrandGetRequest;
$req->setStoreNo("MJ01");
$req->setMemberBarcde("18612642933");
$req->setShoppeNo("00092");
$req->setSerialNo("MJ0173774040001");
$req->setSingleProductList("[{\"tagPrice\":\"3000\",\"unionKey\":\"1\",\"barcode\":\"YOGA001\",\"salePrice\":2888,\"count\":2,\"skuid\":\"6155701\"}]");
$req->setSelectList("[{\"promotionUnionKey\":\"12345678\",\"promotionType\":\"coupon\",\"value\":\"0\"}]");
$req->setExtendParam("{\"xx\",\"xx\"}");
$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=qimen.alibaba.mos.broadingbrand.get' \
-d 'partner_id=apidoc' \
-d 'session=497606a8-2226-43b0-917d-a3d78b1a3127' \
-d 'sign=B1BAF2AF723FD5CA26182B4470E6FC9A' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+00%3A27%3A10' \
-d 'v=2.0' \
-d 'extendParam=%7B%5C%22xx%5C%22%2C%5C%22xx%5C%22%7D' \
-d 'memberBarcde=18612642933' \
-d 'selectList=%7B%22promotionUnionKey%22%3A%2212345678%22%2C%22promotionType%22%3A%22coupon%22%2C%22value%22%3A%220%22%7D' \
-d 'serialNo=MJ0173774040001' \
-d 'shoppeNo=00092' \
-d 'singleProductList=%7B%22tagPrice%22%3A%223000%22%2C%22unionKey%22%3A%221%22%2C%22barcode%22%3A%22YOGA001%22%2C%22salePrice%22%3A2888%2C%22count%22%3A2%2C%22skuid%22%3A%226155701%22%7D' \
-d 'storeNo=MJ01'

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

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

req.storeNo="MJ01"
req.memberBarcde="18612642933"
req.shoppeNo="00092"
req.serialNo="MJ0173774040001"
req.singleProductList="[{\"tagPrice\":\"3000\",\"unionKey\":\"1\",\"barcode\":\"YOGA001\",\"salePrice\":2888,\"count\":2,\"skuid\":\"6155701\"}]"
req.selectList="[{\"promotionUnionKey\":\"12345678\",\"promotionType\":\"coupon\",\"value\":\"0\"}]"
req.extendParam="{\"xx\",\"xx\"}"
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,"qimen.alibaba.mos.broadingbrand.get");
add_param(pRequest,"storeNo","MJ01");
add_param(pRequest,"memberBarcde","18612642933");
add_param(pRequest,"shoppeNo","00092");
add_param(pRequest,"serialNo","MJ0173774040001");
add_param(pRequest,"singleProductList","{"tagPrice":"3000","unionKey":"1","barcode":"YOGA001","salePrice":2888,"count":2,"skuid":"6155701"}");
add_param(pRequest,"selectList","{"promotionUnionKey":"12345678","promotionType":"coupon","value":"0"}");
add_param(pRequest,"extendParam","{\"xx\",\"xx\"}");
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('qimen.alibaba.mos.broadingbrand.get', {
	'storeNo':'MJ01',
	'memberBarcde':'18612642933',
	'shoppeNo':'00092',
	'serialNo':'MJ0173774040001',
	'singleProductList':'{"tagPrice":"3000","unionKey":"1","barcode":"YOGA001","salePrice":2888,"count":2,"skuid":"6155701"}',
	'selectList':'{"promotionUnionKey":"12345678","promotionType":"coupon","value":"0"}',
	'extendParam':'{\"xx\",\"xx\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<errcode>200</errcode>
<isSuccess>true</isSuccess>
<model>
    <memberInfo>
        <nickName>Ethan</nickName>
        <levelName>西有灵犀卡会员</levelName>
        <memberId>5</memberId>
    </memberInfo>
    <notifyMsg>当前订单可办灵犀卡</notifyMsg>
    <promotionGroupList>
        <isShowSummryInfo>false</isShowSummryInfo>
        <name>会员权益</name>
        <promotionList>
            <promotion_list>
                <totalAmount>0</totalAmount>
                <promotionType>
                    <checkedType>UNCHECKED</checkedType>
                </promotionType>
                <unionKey>R84ddfb34126fc3a48ee38d7044e87276</unionKey>
                <name>灵犀卡[365]</name>
                <isAllowEdit>false</isAllowEdit>
            </promotion_list>
        </promotionList>
        <totalPromotion>0</totalPromotion>
    </promotionGroupList>
    <serialNo>MJ0173774040001</serialNo>
    <totalPromotion>500</totalPromotion>
</model>
<message>查询成功</message>

{
    "errcode":"200",
    "isSuccess":true,
    "model":{
        "memberInfo":{
            "nickName":"Ethan",
            "levelName":"西有灵犀卡会员",
            "memberId":"5"
        },
        "notifyMsg":"当前订单可办灵犀卡",
        "promotionGroupList":{
            "isShowSummryInfo":false,
            "name":"会员权益",
            "promotionList":{
                "promotion_list":[
                    {
                        "totalAmount":"0",
                        "promotionType":{
                            "checkedType":"UNCHECKED"
                        },
                        "unionKey":"R84ddfb34126fc3a48ee38d7044e87276",
                        "name":"灵犀卡[365]",
                        "isAllowEdit":false
                    }
                ]
            },
            "totalPromotion":"0"
        },
        "serialNo":"MJ0173774040001",
        "totalPromotion":500
    },
    "message":"查询成功"
}

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.mos.broadingbrand.get (alibaba.mos.broadingbrand.get)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ