淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	描述
query_param	HtSkuInventoryQuery	必须	请求参数
└ sku_keyword String 可选测试 sku关键字:名称/合约/款号 └ warehouse_codes String [] 可选 [] 仓库ID └ first_category_type String 必须 FABRIC/ACCESSORY 物料类型 └ ht_material_code String 可选 4000290992 合泰物料代码 └ ht_contract_code String 可选 24HT093 合泰合约编码 └ ht_style_id String 可选 ST0930 款编码 └ ht_material_color_code String 可选 ABC 色号
page_query	TopPageQuery	必须	topPageQuery
└ current_page Number 必须 1 当前页号 └ page_size Number 必须 20 页大小

名称	类型	示例值	描述
top_result	HSFResult		返回结果
└ success Boolean true 是否成功 └ code Number 401 错误编码 └ msg String 授权异常错误信息 data TopPage 响应结果 items HtSkuInventoryDto [] 分页明细列表 └ sku_id String 90383992829 skuId sku_info HeitaiSkuDto 合泰SKU信息 └ ht_material_code String M982999 合泰物料编码 └ ht_material_name String 测试物料合泰物料名称 └ first_category_type String FABRIC/ACCESSORY 物料类型 └ measurement_unit String M 库存单位 └ weight_unit String G 克重单位 └ fabric_breadth_unit String CM 面料门幅单位 └ ht_material_color String ABC 合泰物料颜色 └ ht_contract_code String 24HT00001 合泰合约编码 └ ht_style_id String 24ST091 合泰的款ID └ customer_provider Boolean true 是否客供 └ ht_material_color_code String ABC 色号 └ fabric_breadth String 100 面料门幅 └ weight BigDecimal 100 克重 └ specification String ABC 规格 └ warehouse_code String 1004 仓ID └ quantity BigDecimal 100 库存数量 └ supplier_material_batch String 11 缸号/锅号 └ material_ext_attr String H1 扩展信息：花型、其它1等 └ total_count Number 100 总数量 └ current_page Number 1 当前页号 └ page_size Number 20 页大小

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XunxiHetaiWmsInventoryQueryRequest req = new XunxiHetaiWmsInventoryQueryRequest();
XunxiHetaiWmsInventoryQueryRequest.HtSkuInventoryQuery obj1 = new XunxiHetaiWmsInventoryQueryRequest.HtSkuInventoryQuery();
obj1.setSkuKeyword("测试");
obj1.setWarehouseCodes("");
obj1.setFirstCategoryType("FABRIC/ACCESSORY");
obj1.setHtMaterialCode("4000290992");
obj1.setHtContractCode("24HT093");
obj1.setHtStyleId("ST0930");
obj1.setHtMaterialColorCode("ABC");
req.setQueryParam(obj1);
XunxiHetaiWmsInventoryQueryRequest.TopPageQuery obj2 = new XunxiHetaiWmsInventoryQueryRequest.TopPageQuery();
obj2.setCurrentPage(1L);
obj2.setPageSize(20L);
req.setPageQuery(obj2);
XunxiHetaiWmsInventoryQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XunxiHetaiWmsInventoryQueryRequest req = new XunxiHetaiWmsInventoryQueryRequest();
XunxiHetaiWmsInventoryQueryRequest.HtSkuInventoryQueryDomain obj1 = new XunxiHetaiWmsInventoryQueryRequest.HtSkuInventoryQueryDomain();
obj1.SkuKeyword = "测试";
obj1.WarehouseCodes = "";
obj1.FirstCategoryType = "FABRIC/ACCESSORY";
obj1.HtMaterialCode = "4000290992";
obj1.HtContractCode = "24HT093";
obj1.HtStyleId = "ST0930";
obj1.HtMaterialColorCode = "ABC";
req.QueryParam_ = obj1;
XunxiHetaiWmsInventoryQueryRequest.TopPageQueryDomain obj2 = new XunxiHetaiWmsInventoryQueryRequest.TopPageQueryDomain();
obj2.CurrentPage = 1L;
obj2.PageSize = 20L;
req.PageQuery_ = obj2;
XunxiHetaiWmsInventoryQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XunxiHetaiWmsInventoryQueryRequest;
$query_param = new HtSkuInventoryQuery;
$query_param->sku_keyword="测试";
$query_param->warehouse_codes="[]";
$query_param->first_category_type="FABRIC/ACCESSORY";
$query_param->ht_material_code="4000290992";
$query_param->ht_contract_code="24HT093";
$query_param->ht_style_id="ST0930";
$query_param->ht_material_color_code="ABC";
$req->setQueryParam(json_encode($query_param));
$page_query = new TopPageQuery;
$page_query->current_page="1";
$page_query->page_size="20";
$req->setPageQuery(json_encode($page_query));
$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=taobao.xunxi.hetai.wms.inventory.query' \
-d 'partner_id=apidoc' \
-d 'sign=957A710A53423C2ED30764D5EE9287E0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A21%3A29' \
-d 'v=2.0' \
-d 'page_query=null' \
-d 'query_param=null'

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

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

req.query_param=""
req.page_query=""
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,"taobao.xunxi.hetai.wms.inventory.query");
add_param(pRequest,"query_param","数据结构JSON示例");
add_param(pRequest,"page_query","数据结构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('taobao.xunxi.hetai.wms.inventory.query', {
	'query_param':'数据结构JSON示例',
	'page_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xunxi_hetai_wms_inventory_query_response>
    <top_result>
        <success>true</success>
        <code>401</code>
        <msg>授权异常</msg>
        <data>
            <items>
                <ht_sku_inventory_dto>
                    <sku_id>90383992829</sku_id>
                    <sku_info>
                        <ht_material_code>M982999</ht_material_code>
                        <ht_material_name>测试物料</ht_material_name>
                        <first_category_type>FABRIC/ACCESSORY</first_category_type>
                        <measurement_unit>M</measurement_unit>
                        <weight_unit>G</weight_unit>
                        <fabric_breadth_unit>CM</fabric_breadth_unit>
                        <ht_material_color>ABC</ht_material_color>
                        <ht_contract_code>24HT00001</ht_contract_code>
                        <ht_style_id>24ST091</ht_style_id>
                        <customer_provider>true</customer_provider>
                        <ht_material_color_code>ABC</ht_material_color_code>
                        <fabric_breadth>100</fabric_breadth>
                        <weight>100</weight>
                        <specification>ABC</specification>
                    </sku_info>
                    <warehouse_code>1004</warehouse_code>
                    <quantity>100</quantity>
                    <supplier_material_batch>11</supplier_material_batch>
                    <material_ext_attr>H1</material_ext_attr>
                </ht_sku_inventory_dto>
            </items>
            <total_count>100</total_count>
            <current_page>1</current_page>
            <page_size>20</page_size>
        </data>
    </top_result>
</xunxi_hetai_wms_inventory_query_response>

{
    "xunxi_hetai_wms_inventory_query_response":{
        "top_result":{
            "success":true,
            "code":401,
            "msg":"授权异常",
            "data":{
                "items":{
                    "ht_sku_inventory_dto":[
                        {
                            "sku_id":"90383992829",
                            "sku_info":{
                                "ht_material_code":"M982999",
                                "ht_material_name":"测试物料",
                                "first_category_type":"FABRIC\/ACCESSORY",
                                "measurement_unit":"M",
                                "weight_unit":"G",
                                "fabric_breadth_unit":"CM",
                                "ht_material_color":"ABC",
                                "ht_contract_code":"24HT00001",
                                "ht_style_id":"24ST091",
                                "customer_provider":true,
                                "ht_material_color_code":"ABC",
                                "fabric_breadth":"100",
                                "weight":"100",
                                "specification":"ABC"
                            },
                            "warehouse_code":"1004",
                            "quantity":"100",
                            "supplier_material_batch":"11",
                            "material_ext_attr":"H1"
                        }
                    ]
                },
                "total_count":100,
                "current_page":1,
                "page_size":20
            }
        }
    }
}

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

taobao.xunxi.hetai.wms.inventory.query (【HTW009】分页查询WMS库存)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ