阿里大于 -

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	BrandOrderExternalReq	必须			请求参数
└ start_date String 必须 20240901 出库时间-开始日期 └ end_date String 必须 20240901 出库时间-结束日期 └ brand_ids String [] 必须 ["123", "456"] 品牌iD列表 └ item_ids String [] 可选 ["123", "456"] 货品id列表 └ page_num Number 必须 1 页号 └ page_size Number 必须 10 页大小

名称	类型	示例值	描述
result	PagedResult		result
└ error_detail_msg String error 详细错误信息 └ total_page Number 198 总页数 └ error_message String error 错误信息 └ page_size Number 10 页大小 └ error_code String errorCode 错误码 └ total_count Number 100 总条数 result BrandWmsInventoryDfRes [] result └ biz_order_time String 2024-09-03 23:42:42 业务创单时间：2B销售为销售创单时间；调拨出库为调拨创单时间；2B销退入库为2B销退创单时间 └ sale_type String 2B销售 2B销售；调拨出库；2B销退入库 └ sale_ou String 广东批发入库仓库-采购主体 └ manufacturer String xxx公司货品-生产厂家 └ expiry_date String 2027-01-03 失效日期 └ produce_date String 2022-01-04 生产日期 └ sale_time String 2024-09-03 23:42:00 销售日期 └ sc_item_name String xxx 21片/盒标准装货品名称 └ store_name String 仓库名称仓库名称：2B销售、调拨出库为出库仓库名称；2B销退入库为入库名称 └ sale_order_amt String 100.00 销售金额（元）：2B销售为实际销售金额=销售价实际出库数量；调拨出库为空；2B销退入库为实际入库数量订单销售价（含税）, 单位：元 └ brand_name String 品牌名称货品-品牌名称 └ biz_no String LP1234 业务单号：2B销售为销售单号；调拨出库为调拨单号；2B销退入库为2B销退单号 └ sale_price String 100.00 销售价格（元）：2B销售为销售价；调拨出库为空；2B销退入库为销退价（含税）, 单位：元 └ batch_code String 123B 货品生产批号 └ sc_itm_desc String 21片/盒货品-规格 └ sc_item_id String 1234 货品id └ basic_unit String 盒包装单位 └ approval_number String 国药准字xxx 货品-批准文号 └ sc_item_dest_name String xxx公司收货单位名称：2B销售为客户名称；调拨出库为目的仓名称；2B销退入库为客户名称 └ bar_code String 691234 货品-条形码 └ brand_id String 1234 货品-品牌id └ sale_qty Number 1 销售数量：2B销售为实际出库数量；调拨出库为实际出库数量；2B销退入库为实际入库数量（负数） └ store_code String PGXXX 仓库编码：2B销售、调拨出库为出库仓库编码；2B销退入库为入库编码 └ customer_detail_address String xxx 客户收货详细地址 └ page_index Number 1 页号 └ success Boolean true 是否成功 └ current_page Number 1 当前页号

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthBrandWmsSaleQueryRequest req = new AlibabaAlihealthBrandWmsSaleQueryRequest();
AlibabaAlihealthBrandWmsSaleQueryRequest.BrandOrderExternalReq obj1 = new AlibabaAlihealthBrandWmsSaleQueryRequest.BrandOrderExternalReq();
obj1.setStartDate("20240901");
obj1.setEndDate("20240901");
obj1.setBrandIds(""123", "456"");
obj1.setItemIds(""123", "456"");
obj1.setPageNum(1L);
obj1.setPageSize(10L);
req.setParam(obj1);
AlibabaAlihealthBrandWmsSaleQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthBrandWmsSaleQueryRequest req = new AlibabaAlihealthBrandWmsSaleQueryRequest();
AlibabaAlihealthBrandWmsSaleQueryRequest.BrandOrderExternalReqDomain obj1 = new AlibabaAlihealthBrandWmsSaleQueryRequest.BrandOrderExternalReqDomain();
obj1.StartDate = "20240901";
obj1.EndDate = "20240901";
obj1.BrandIds = ""123", "456"";
obj1.ItemIds = ""123", "456"";
obj1.PageNum = 1L;
obj1.PageSize = 10L;
req.Param_ = obj1;
AlibabaAlihealthBrandWmsSaleQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthBrandWmsSaleQueryRequest;
$param = new BrandOrderExternalReq;
$param->start_date="20240901";
$param->end_date="20240901";
$param->brand_ids="[\"123\", \"456\"]";
$param->item_ids="[\"123\", \"456\"]";
$param->page_num="1";
$param->page_size="10";
$req->setParam(json_encode($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=alibaba.alihealth.brand.wms.sale.query' \
-d 'partner_id=apidoc' \
-d 'sign=71604227BFB7332538B7187A07AF81F4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A25%3A55' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param="数据结构示例JSON格式"
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,"alibaba.alihealth.brand.wms.sale.query");
add_param(pRequest,"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('alibaba.alihealth.brand.wms.sale.query', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_brand_wms_sale_query_response>
    <result>
        <error_detail_msg>error</error_detail_msg>
        <total_page>198</total_page>
        <error_message>error</error_message>
        <page_size>10</page_size>
        <error_code>errorCode</error_code>
        <total_count>100</total_count>
        <result>
            <brand_wms_inventory_df_res>
                <biz_order_time>2024-09-03 23:42:42</biz_order_time>
                <sale_type>2B销售</sale_type>
                <sale_ou>广东批发</sale_ou>
                <manufacturer>xxx公司</manufacturer>
                <expiry_date>2027-01-03</expiry_date>
                <produce_date>2022-01-04</produce_date>
                <sale_time>2024-09-03 23:42:00</sale_time>
                <sc_item_name>xxx 21片/盒 标准装</sc_item_name>
                <store_name>仓库名称</store_name>
                <sale_order_amt>100.00</sale_order_amt>
                <brand_name>品牌名称</brand_name>
                <biz_no>LP1234</biz_no>
                <sale_price>100.00</sale_price>
                <batch_code>123B</batch_code>
                <sc_itm_desc>21片/盒</sc_itm_desc>
                <sc_item_id>1234</sc_item_id>
                <basic_unit>盒</basic_unit>
                <approval_number>国药准字xxx</approval_number>
                <sc_item_dest_name>xxx公司</sc_item_dest_name>
                <bar_code>691234</bar_code>
                <brand_id>1234</brand_id>
                <sale_qty>1</sale_qty>
                <store_code>PGXXX</store_code>
                <customer_detail_address>xxx</customer_detail_address>
            </brand_wms_inventory_df_res>
        </result>
        <page_index>1</page_index>
        <success>true</success>
        <current_page>1</current_page>
    </result>
</alibaba_alihealth_brand_wms_sale_query_response>

{
    "alibaba_alihealth_brand_wms_sale_query_response":{
        "result":{
            "error_detail_msg":"error",
            "total_page":198,
            "error_message":"error",
            "page_size":10,
            "error_code":"errorCode",
            "total_count":100,
            "result":{
                "brand_wms_inventory_df_res":[
                    {
                        "biz_order_time":"2024-09-03 23:42:42",
                        "sale_type":"2B销售",
                        "sale_ou":"广东批发",
                        "manufacturer":"xxx公司",
                        "expiry_date":"2027-01-03",
                        "produce_date":"2022-01-04",
                        "sale_time":"2024-09-03 23:42:00",
                        "sc_item_name":"xxx 21片\/盒 标准装",
                        "store_name":"仓库名称",
                        "sale_order_amt":"100.00",
                        "brand_name":"品牌名称",
                        "biz_no":"LP1234",
                        "sale_price":"100.00",
                        "batch_code":"123B",
                        "sc_itm_desc":"21片\/盒",
                        "sc_item_id":"1234",
                        "basic_unit":"盒",
                        "approval_number":"国药准字xxx",
                        "sc_item_dest_name":"xxx公司",
                        "bar_code":"691234",
                        "brand_id":"1234",
                        "sale_qty":1,
                        "store_code":"PGXXX",
                        "customer_detail_address":"xxx"
                    }
                ]
            },
            "page_index":1,
            "success":true,
            "current_page":1
        }
    }
}

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

alibaba.alihealth.brand.wms.sale.query (阿里健康-品牌-自营-供应链-仓内作业-库存-WMS销售信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ