淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
title	String	可选	尺码表		搜索模块时，用到的模块标题关键词
current_page	Number	可选	3	默认值：1	查明卖家的模块列表时，支持分页查询此参数表示要获取第几页
page_size	Number	可选	20	默认值：100	查明卖家的模块列表时，支持分页查询此参数表示分页的大小
order_by	Number	可选	1	默认值：1	排序方式 0：代表升序；1：代表降序
order_field	Number	可选	1	默认值：1	排序字段，支持两种排序模块的修改时间和创建时间 0：代表创建时间；1：代表修改时间

名称	类型	示例值	描述
total_results	Number	66	获取到的自定义描述模块数量
custom_desc_modules	CustomDescModule []		获取到的自定义描述模块列表
└ id Number 1001 自定义描述模块的编号 └ user_id Number 234523452345 模块所属卖家的数字id └ title String 尺码表自定义描述模块的名称 └ memo String 女装用尺码表自定义描述模块的备注 └ content String 模块内容。。。。。。自定义描述模块的内容 └ gmt_create Date 2000-01-01 00:00:00 自定义描述模块创建时间 └ gmt_modified Date 2000-01-01 00:00:00 自定义描述模块修改时间

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
ItemModulesGetRequest req = new ItemModulesGetRequest();
req.setTitle("尺码表");
req.setCurrentPage(3L);
req.setPageSize(20L);
req.setOrderBy(1L);
req.setOrderField(1L);
ItemModulesGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
ItemModulesGetRequest req = new ItemModulesGetRequest();
req.Title = "尺码表";
req.CurrentPage = 3L;
req.PageSize = 20L;
req.OrderBy = 1L;
req.OrderField = 1L;
ItemModulesGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new ItemModulesGetRequest;
$req->setTitle("尺码表");
$req->setCurrentPage("3");
$req->setPageSize("20");
$req->setOrderBy("1");
$req->setOrderField("1");
$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=taobao.item.modules.get' \
-d 'partner_id=apidoc' \
-d 'session=780f799d-7709-414f-b2f5-5f98cd570d0b' \
-d 'sign=A6DCA4F33F56F9982F27EE89DC22209F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+06%3A51%3A43' \
-d 'v=2.0' \
-d 'current_page=3' \
-d 'order_by=1' \
-d 'order_field=1' \
-d 'page_size=20' \
-d 'title=%E5%B0%BA%E7%A0%81%E8%A1%A8'

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

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

req.title="尺码表"
req.current_page=3
req.page_size=20
req.order_by=1
req.order_field=1
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,"taobao.item.modules.get");
add_param(pRequest,"title","尺码表");
add_param(pRequest,"current_page","3");
add_param(pRequest,"page_size","20");
add_param(pRequest,"order_by","1");
add_param(pRequest,"order_field","1");
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('taobao.item.modules.get', {
	'title':'尺码表',
	'current_page':'3',
	'page_size':'20',
	'order_by':'1',
	'order_field':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<item_modules_get_response>
    <total_results>66</total_results>
    <custom_desc_modules>
        <custom_desc_module>
            <id>1001</id>
            <user_id>234523452345</user_id>
            <title>尺码表</title>
            <memo>女装用尺码表</memo>
            <content>模块内容。。。。。。</content>
            <gmt_create>2000-01-01 00:00:00</gmt_create>
            <gmt_modified>2000-01-01 00:00:00</gmt_modified>
        </custom_desc_module>
    </custom_desc_modules>
</item_modules_get_response>

{
    "item_modules_get_response":{
        "total_results":66,
        "custom_desc_modules":{
            "custom_desc_module":[
                {
                    "id":1001,
                    "user_id":234523452345,
                    "title":"尺码表",
                    "memo":"女装用尺码表",
                    "content":"模块内容。。。。。。",
                    "gmt_create":"2000-01-01 00:00:00",
                    "gmt_modified":"2000-01-01 00:00:00"
                }
            ]
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
isv.error-get-custom-desc-module	系统错误，获取卖家自定义宝贝描述模块信息失败！	请稍候重试或联系管理员。

API测试工具错误码查询工具 SDK下载

开放平台

商品API

taobao.item.modules.get (获取卖家自定义描述模块)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ