阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request_param	LabelTemplateQueryTopRequest	可选			请求参数
└ code String 可选 item001 标签模板code └ type Number 可选 1 标签模板类型 └ scene Number 可选 1 标签模板使用场景 └ page_index Number 可选 1 页码 └ page_size Number 可选 1 页大小 └ version Number 可选 1 模板版本 └ warehouse_code String 可选 52 仓库code

名称	类型	示例值	描述
result	UmsResult	result	返回结果
└ code String success 响应码 data Pagination data 响应数据 └ total Number 1 总数 results Results [] results 结果集 └ code String item001 标签模板code └ name String 定量不定重标签标签模板名称 └ content String [ { "code": "定量不定重商品标签", //标签格式编号 "name": "定量不定重商品标签", //标签格式名称，可与编号一致 "width": 60, //标签格式宽度(毫米) "height": 42, //标签格式高度(毫米) "rotate": 0, //图像旋转角度, 0表示不旋转, 1表示旋转180度 "fields": [ { "code": "free_image2", //标签中，每个域的编号, free_image2 表示自由图像2 "x": 2, //该域的x位置, 毫米，最左侧为x=0 "y": 11, //该域的x位置, 毫米，最顶部为=0 "width": 57, "height": 1, "font_name": "微软雅黑", //该域的字体名称, 图像和条码等不用 "font_style": 0, //该域的字体风格, 图像和条码等不用 "font_size": 12,//该域的字体大小, 图像和条码等不用 //图像的base64编码 "data_content": "Qk2+AAAAAAAAAD4AAAAoAAAA+QEAAAIAAAABAAEAAAAAAIAAAADEDgAAxA4AAAAAAAAAAAAAAAAAAP///wAcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccOHDjhw4444cYwAHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHDhw44cOOOOHGMAA==", "field_format": "", "print_title": 0 }, { "code": "subpackageMerchantName", //标签中，每个域的编号, subpackageMerchantName 表示分装商 "x": 4, "y": 22, "width": 55, "height": 3, "font_name": "微软雅黑", "font_style": 0, "font_size": 18, "data_content": "分装商", //打印title的内容, 如此为空且print_title为1,则打印默认的title "field_format": "", "print_title": 1 //是否打印title, 0不打印，1打印 }, { "code": "barcode", "x": 6, "y": 30, "width": 52, "height": 10, "font_name": "微软雅黑", "font_style": 0, "font_size": 15, "data_content": "", "field_format": "6", //条码格式的编号 //BARCODE_TYPE_EAN13 = 0; //BARCODE_TYPE_EAN8 = 1; //BARCODE_TYPE_ITF = 2; //BARCODE_TYPE_UPCA = 3; //BARCODE_TYPE_UPCE = 4; //BARCODE_TYPE_CODE39 = 5; //BARCODE_TYPE_CODE128 = 6; //BARCODE_TYPE_CODABAR = 7; //BARCODE_TYPE_PDF47 = 8; //BARCODE_TYPE_DATAMATRIX = 9; //BARCODE_TYPE_QR = 10; "print_title": 0 } ] } ] 标签模板内容 └ mssage String success 响应描述信息 └ success Boolean true 是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
WdkUmsLabelTemplatePageQueryRequest req = new WdkUmsLabelTemplatePageQueryRequest();
WdkUmsLabelTemplatePageQueryRequest.LabelTemplateQueryTopRequest obj1 = new WdkUmsLabelTemplatePageQueryRequest.LabelTemplateQueryTopRequest();
obj1.setCode("item001");
obj1.setType(1L);
obj1.setScene(1L);
obj1.setPageIndex(1L);
obj1.setPageSize(1L);
obj1.setVersion(1L);
obj1.setWarehouseCode("52");
req.setRequestParam(obj1);
WdkUmsLabelTemplatePageQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
WdkUmsLabelTemplatePageQueryRequest req = new WdkUmsLabelTemplatePageQueryRequest();
WdkUmsLabelTemplatePageQueryRequest.LabelTemplateQueryTopRequestDomain obj1 = new WdkUmsLabelTemplatePageQueryRequest.LabelTemplateQueryTopRequestDomain();
obj1.Code = "item001";
obj1.Type = 1L;
obj1.Scene = 1L;
obj1.PageIndex = 1L;
obj1.PageSize = 1L;
obj1.Version = 1L;
obj1.WarehouseCode = "52";
req.RequestParam_ = obj1;
WdkUmsLabelTemplatePageQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new WdkUmsLabelTemplatePageQueryRequest;
$request_param = new LabelTemplateQueryTopRequest;
$request_param->code="item001";
$request_param->type="1";
$request_param->scene="1";
$request_param->page_index="1";
$request_param->page_size="1";
$request_param->version="1";
$request_param->warehouse_code="52";
$req->setRequestParam(json_encode($request_param));
$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=wdk.ums.label.template.page.query' \
-d 'partner_id=apidoc' \
-d 'sign=85FA7B868005906EA64BAFD16A065EED' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+21%3A54%3A57' \
-d 'v=2.0' \
-d 'request_param=null'

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

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

req.request_param=""
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,"wdk.ums.label.template.page.query");
add_param(pRequest,"request_param","数据结构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('wdk.ums.label.template.page.query', {
	'request_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<wdk_ums_label_template_page_query_response>
    <result>
        <code>success</code>
        <data>
            <total>1</total>
            <results>
                <results>
                    <code>item001</code>
                    <name>定量不定重标签</name>
                    <content>[   {     &quot;code&quot;: &quot;定量不定重商品标签&quot;,  //标签格式编号     &quot;name&quot;: &quot;定量不定重商品标签&quot;,  //标签格式名称，可与编号一致     &quot;width&quot;: 60,  //标签格式宽度(毫米)     &quot;height&quot;: 42,  //标签格式高度(毫米)     &quot;rotate&quot;: 0,  //图像旋转角度, 0表示不旋转, 1表示旋转180度     &quot;fields&quot;: [        {         &quot;code&quot;: &quot;free_image2&quot;, //标签中，每个域的编号, free_image2 表示自由图像2         &quot;x&quot;: 2,  //该域的x位置, 毫米，最左侧为x=0         &quot;y&quot;: 11, //该域的x位置, 毫米，最顶部为=0         &quot;width&quot;: 57,         &quot;height&quot;: 1,         &quot;font_name&quot;: &quot;微软雅黑&quot;, //该域的字体名称, 图像和条码等不用         &quot;font_style&quot;: 0, //该域的字体风格, 图像和条码等不用         &quot;font_size&quot;: 12,//该域的字体大小, 图像和条码等不用      //图像的base64编码         &quot;data_content&quot;: &quot;Qk2+AAAAAAAAAD4AAAAoAAAA+QEAAAIAAAABAAEAAAAAAIAAAADEDgAAxA4AAAAAAAAAAAAAAAAAAP///wAcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccOHDjhw4444cYwAHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHDhw44cOOOOHGMAA==&quot;,         &quot;field_format&quot;: &quot;&quot;,         &quot;print_title&quot;: 0       },       {         &quot;code&quot;: &quot;subpackageMerchantName&quot;, //标签中，每个域的编号, subpackageMerchantName 表示分装商         &quot;x&quot;: 4,         &quot;y&quot;: 22,         &quot;width&quot;: 55,         &quot;height&quot;: 3,         &quot;font_name&quot;: &quot;微软雅黑&quot;,         &quot;font_style&quot;: 0,         &quot;font_size&quot;: 18,         &quot;data_content&quot;: &quot;分装商&quot;, //打印title的内容, 如此为空且print_title为1,则打印默认的title         &quot;field_format&quot;: &quot;&quot;,         &quot;print_title&quot;: 1  //是否打印title, 0不打印，1打印       },              {         &quot;code&quot;: &quot;barcode&quot;,          &quot;x&quot;: 6,         &quot;y&quot;: 30,         &quot;width&quot;: 52,         &quot;height&quot;: 10,         &quot;font_name&quot;: &quot;微软雅黑&quot;,         &quot;font_style&quot;: 0,         &quot;font_size&quot;: 15,         &quot;data_content&quot;: &quot;&quot;,         &quot;field_format&quot;: &quot;6&quot;, //条码格式的编号   //BARCODE_TYPE_EAN13 = 0;   //BARCODE_TYPE_EAN8 = 1;   //BARCODE_TYPE_ITF = 2;   //BARCODE_TYPE_UPCA = 3;   //BARCODE_TYPE_UPCE = 4;   //BARCODE_TYPE_CODE39 = 5;   //BARCODE_TYPE_CODE128 = 6;   //BARCODE_TYPE_CODABAR = 7;   //BARCODE_TYPE_PDF47 = 8;   //BARCODE_TYPE_DATAMATRIX = 9;   //BARCODE_TYPE_QR = 10;         &quot;print_title&quot;: 0       }     ]   } ]</content>
                </results>
            </results>
        </data>
        <mssage>success</mssage>
        <success>true</success>
    </result>
</wdk_ums_label_template_page_query_response>

{
    "wdk_ums_label_template_page_query_response":{
        "result":{
            "code":"success",
            "data":{
                "total":1,
                "results":{
                    "results":[
                        {
                            "code":"item001",
                            "name":"定量不定重标签",
                            "content":"[   {     \"code\": \"定量不定重商品标签\",  \/\/标签格式编号     \"name\": \"定量不定重商品标签\",  \/\/标签格式名称，可与编号一致     \"width\": 60,  \/\/标签格式宽度(毫米)     \"height\": 42,  \/\/标签格式高度(毫米)     \"rotate\": 0,  \/\/图像旋转角度, 0表示不旋转, 1表示旋转180度     \"fields\": [        {         \"code\": \"free_image2\", \/\/标签中，每个域的编号, free_image2 表示自由图像2         \"x\": 2,  \/\/该域的x位置, 毫米，最左侧为x=0         \"y\": 11, \/\/该域的x位置, 毫米，最顶部为=0         \"width\": 57,         \"height\": 1,         \"font_name\": \"微软雅黑\", \/\/该域的字体名称, 图像和条码等不用         \"font_style\": 0, \/\/该域的字体风格, 图像和条码等不用         \"font_size\": 12,\/\/该域的字体大小, 图像和条码等不用      \/\/图像的base64编码         \"data_content\": \"Qk2+AAAAAAAAAD4AAAAoAAAA+QEAAAIAAAABAAEAAAAAAIAAAADEDgAAxA4AAAAAAAAAAAAAAAAAAP\/\/\/wAcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccOHDjhw4444cYwAHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHDhw44cOOOOHGMAA==\",         \"field_format\": \"\",         \"print_title\": 0       },       {         \"code\": \"subpackageMerchantName\", \/\/标签中，每个域的编号, subpackageMerchantName 表示分装商         \"x\": 4,         \"y\": 22,         \"width\": 55,         \"height\": 3,         \"font_name\": \"微软雅黑\",         \"font_style\": 0,         \"font_size\": 18,         \"data_content\": \"分装商\", \/\/打印title的内容, 如此为空且print_title为1,则打印默认的title         \"field_format\": \"\",         \"print_title\": 1  \/\/是否打印title, 0不打印，1打印       },              {         \"code\": \"barcode\",          \"x\": 6,         \"y\": 30,         \"width\": 52,         \"height\": 10,         \"font_name\": \"微软雅黑\",         \"font_style\": 0,         \"font_size\": 15,         \"data_content\": \"\",         \"field_format\": \"6\", \/\/条码格式的编号   \/\/BARCODE_TYPE_EAN13 = 0;   \/\/BARCODE_TYPE_EAN8 = 1;   \/\/BARCODE_TYPE_ITF = 2;   \/\/BARCODE_TYPE_UPCA = 3;   \/\/BARCODE_TYPE_UPCE = 4;   \/\/BARCODE_TYPE_CODE39 = 5;   \/\/BARCODE_TYPE_CODE128 = 6;   \/\/BARCODE_TYPE_CODABAR = 7;   \/\/BARCODE_TYPE_PDF47 = 8;   \/\/BARCODE_TYPE_DATAMATRIX = 9;   \/\/BARCODE_TYPE_QR = 10;         \"print_title\": 0       }     ]   } ]"
                        }
                    ]
                }
            },
            "mssage":"success",
            "success":true
        }
    }
}

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

wdk.ums.label.template.page.query (查询标签模板信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈