淘宝开放平台 - 文档中心

请求地址：

环境	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	ScmSaleStatisticExportQuery	必须			入参
└ gmt_month Number 必须 3 月份 └ gmt_year Number 必须 2020 年份 └ page_size Number 必须 100 每页条数 └ brand_identity String 必须 GSK 品牌方标识 └ page_num Number 必须 0 页码

名称	类型	示例值	描述
result	JkPageResult		出参
└ total_page Number 137544 总页数 └ success Boolean true 是否成功 item_list AlihealthScmSaleStatisticDto [] 列表 └ gmt_modified Date 2020-03-01 修改日期 └ gmt_year Number 2020 年份 └ cate_level2_name String OTC药品类目 └ receiver_province String 北京收货省份 └ sfcate4_name String demo 类目 └ receiver_city String 北京市收货市 └ spec String 12G12袋/盒规格 └ gmt_month Number 2 月份 └ features String demo 扩展属性 └ seller_id Number 3475858679 店铺id └ sfcate3_name String demo 类目 └ cate_level4_name String demo 类目 └ sc_item_name String 同仁堂感冒清热颗粒12g12袋风寒感冒药头痛发热咳嗽咽干流清涕货品名称 └ cate_level3_name String 感冒咳嗽类目 └ id Number 1 主键 └ outbound_quantity Number 22 当月销售出库数量 └ class_name String com.alibaba.health.scm.service.dto.brand.AlihealthScmSaleStatisticDTO 类名 └ refund_amount Number demo 当月退款金额 └ seller_nick String 同仁堂官方旗舰店店铺名称 └ sfcate2_name String 感冒咳嗽类目 └ sf_cate3_id String demo 类目 └ brand_name String 同仁堂品牌名称 └ sf_cate4_id String demo 类目 └ sf_cate1_id String 72120003 类目 └ sf_cate2_id String 72020002 类目 └ cate_level5_name String demo 类目 └ inbound_quantity Number 1 当月退货入库量 └ sc_item_id Number 560898116535 货品id └ gmt_create Date 2020-03-01 创建时间 └ gmv_amount Number 100890 GMV（包含退款金额） └ cate_level1_name String OTC药品/国际医药 demo └ cate_level3_id String 50023740 demo └ cate_level2_id String 50023720 demo └ sfcate1_name String OTC药品 demo └ cate_level5_id String demo 类目 └ cate_level4_id String demo 类目 └ brand_id Number 44652 品牌 └ cate_level1_id String 201273575 类目 └ page_size Number 10 每页数量 └ sys_error_code String demo 错误编码 └ has_next Boolean true 是否有 └ total_rows Number 1375437 总行数 └ class_name String com.alibaba.health.scm.service.dto.zydprice.JkPageResult 类名 └ page_num Number 1 页码 └ sys_error_msg String demo 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSupplierScmsaleQueryRequest req = new AlibabaAlihealthSupplierScmsaleQueryRequest();
AlibabaAlihealthSupplierScmsaleQueryRequest.ScmSaleStatisticExportQuery obj1 = new AlibabaAlihealthSupplierScmsaleQueryRequest.ScmSaleStatisticExportQuery();
obj1.setGmtMonth(3L);
obj1.setGmtYear(2020L);
obj1.setPageSize(100L);
obj1.setBrandIdentity("GSK");
obj1.setPageNum(0L);
req.setParam(obj1);
AlibabaAlihealthSupplierScmsaleQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSupplierScmsaleQueryRequest req = new AlibabaAlihealthSupplierScmsaleQueryRequest();
AlibabaAlihealthSupplierScmsaleQueryRequest.ScmSaleStatisticExportQueryDomain obj1 = new AlibabaAlihealthSupplierScmsaleQueryRequest.ScmSaleStatisticExportQueryDomain();
obj1.GmtMonth = 3L;
obj1.GmtYear = 2020L;
obj1.PageSize = 100L;
obj1.BrandIdentity = "GSK";
obj1.PageNum = 0L;
req.Param_ = obj1;
AlibabaAlihealthSupplierScmsaleQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSupplierScmsaleQueryRequest;
$param = new ScmSaleStatisticExportQuery;
$param->gmt_month="3";
$param->gmt_year="2020";
$param->page_size="100";
$param->brand_identity="GSK";
$param->page_num="0";
$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.supplier.scmsale.query' \
-d 'partner_id=apidoc' \
-d 'sign=51BCB8F1AAEC262487CF6A8E5C46F910' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-24+15%3A59%3A59' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.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,"alibaba.alihealth.supplier.scmsale.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.supplier.scmsale.query', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_supplier_scmsale_query_response>
    <result>
        <total_page>137544</total_page>
        <success>true</success>
        <item_list>
            <alihealth_scm_sale_statistic_dto>
                <gmt_modified>2020-03-01</gmt_modified>
                <gmt_year>2020</gmt_year>
                <cate_level2_name>OTC药品</cate_level2_name>
                <receiver_province>北京</receiver_province>
                <sfcate4_name>demo</sfcate4_name>
                <receiver_city>北京市</receiver_city>
                <spec>12G*12袋/盒</spec>
                <gmt_month>2</gmt_month>
                <features>demo</features>
                <seller_id>3475858679</seller_id>
                <sfcate3_name>demo</sfcate3_name>
                <cate_level4_name>demo</cate_level4_name>
                <sc_item_name>同仁堂感冒清热颗粒12g*12袋风寒感冒药头痛发热咳嗽咽干流清涕</sc_item_name>
                <cate_level3_name>感冒咳嗽</cate_level3_name>
                <id>1</id>
                <outbound_quantity>22</outbound_quantity>
                <class_name>com.alibaba.health.scm.service.dto.brand.AlihealthScmSaleStatisticDTO</class_name>
                <refund_amount>demo</refund_amount>
                <seller_nick>同仁堂官方旗舰店</seller_nick>
                <sfcate2_name>感冒咳嗽</sfcate2_name>
                <sf_cate3_id>demo</sf_cate3_id>
                <brand_name>同仁堂</brand_name>
                <sf_cate4_id>demo</sf_cate4_id>
                <sf_cate1_id>72120003</sf_cate1_id>
                <sf_cate2_id>72020002</sf_cate2_id>
                <cate_level5_name>demo</cate_level5_name>
                <inbound_quantity>1</inbound_quantity>
                <sc_item_id>560898116535</sc_item_id>
                <gmt_create>2020-03-01</gmt_create>
                <gmv_amount>100890</gmv_amount>
                <cate_level1_name>OTC药品/国际医药</cate_level1_name>
                <cate_level3_id>50023740</cate_level3_id>
                <cate_level2_id>50023720</cate_level2_id>
                <sfcate1_name>OTC药品</sfcate1_name>
                <cate_level5_id>demo</cate_level5_id>
                <cate_level4_id>demo</cate_level4_id>
                <brand_id>44652</brand_id>
                <cate_level1_id>201273575</cate_level1_id>
            </alihealth_scm_sale_statistic_dto>
        </item_list>
        <page_size>10</page_size>
        <sys_error_code>demo</sys_error_code>
        <has_next>true</has_next>
        <total_rows>1375437</total_rows>
        <class_name>com.alibaba.health.scm.service.dto.zydprice.JkPageResult</class_name>
        <page_num>1</page_num>
        <sys_error_msg>demo</sys_error_msg>
    </result>
</alibaba_alihealth_supplier_scmsale_query_response>

{
    "alibaba_alihealth_supplier_scmsale_query_response":{
        "result":{
            "total_page":137544,
            "success":true,
            "item_list":{
                "alihealth_scm_sale_statistic_dto":[
                    {
                        "gmt_modified":"2020-03-01",
                        "gmt_year":2020,
                        "cate_level2_name":"OTC药品",
                        "receiver_province":"北京",
                        "sfcate4_name":"demo",
                        "receiver_city":"北京市",
                        "spec":"12G*12袋\/盒",
                        "gmt_month":2,
                        "features":"demo",
                        "seller_id":3475858679,
                        "sfcate3_name":"demo",
                        "cate_level4_name":"demo",
                        "sc_item_name":"同仁堂感冒清热颗粒12g*12袋风寒感冒药头痛发热咳嗽咽干流清涕",
                        "cate_level3_name":"感冒咳嗽",
                        "id":1,
                        "outbound_quantity":22,
                        "class_name":"com.alibaba.health.scm.service.dto.brand.AlihealthScmSaleStatisticDTO",
                        "refund_amount":demo,
                        "seller_nick":"同仁堂官方旗舰店",
                        "sfcate2_name":"感冒咳嗽",
                        "sf_cate3_id":"demo",
                        "brand_name":"同仁堂",
                        "sf_cate4_id":"demo",
                        "sf_cate1_id":"72120003",
                        "sf_cate2_id":"72020002",
                        "cate_level5_name":"demo",
                        "inbound_quantity":1,
                        "sc_item_id":560898116535,
                        "gmt_create":"2020-03-01",
                        "gmv_amount":100890,
                        "cate_level1_name":"OTC药品\/国际医药",
                        "cate_level3_id":"50023740",
                        "cate_level2_id":"50023720",
                        "sfcate1_name":"OTC药品",
                        "cate_level5_id":"demo",
                        "cate_level4_id":"demo",
                        "brand_id":44652,
                        "cate_level1_id":"201273575"
                    }
                ]
            },
            "page_size":10,
            "sys_error_code":"demo",
            "has_next":true,
            "total_rows":1375437,
            "class_name":"com.alibaba.health.scm.service.dto.zydprice.JkPageResult",
            "page_num":1,
            "sys_error_msg":"demo"
        }
    }
}

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.supplier.scmsale.query (品牌方销售数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ