淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
shop_code	String	必须	8028	门店编码
merchant_code	String	必须	HM	商家编码
cabinet_code	String	必须	AC00004	库位编码

名称	类型	示例值	描述
result	Result		result
data RexShelfDisplayResponseDTO data shelf_sku_detail_list ShelfSkuDetailList [] 货架商品陈列详情列表 └ z_face_num Number 1 z面陈列量 └ layer_num Number 1 层号 └ sku_name String 安格斯谷饲菲力牛排 120g 商品名称 └ pic_url String https://img.alicdn.com/imgextra/i2/263685747/O1CN012ICNLI1sKBJXR0GWo_!!263685747.jpg 图片URL └ depth String 7 深度 └ side_cap_x String 1 侧挂X └ hole_num Number 1 孔号 └ x_face_num Number 1 x面陈列量 └ width String 22 宽度 └ display_num Number 0 陈列总量 └ stack_cap_y String 10 堆叠Y └ location_num Number 1 位置号 └ y_face_num Number 1 y面陈列量 └ sku_code String 444574025 商品编码 └ height String 16 高度 shelf_detail_info RexShelfDetailInfoDTO 货架详情信息 └ shelf_code String LF4-B2 货架编码 └ depth String 35 深度 └ is_mirror Boolean false 是否镜像 └ width String 200 宽度 └ display_unit_code String WLD0006 陈列单元编码 └ hole_distance String 5 孔距 └ planogram_name String 12345 陈列图名称 └ manage_shelf_code Number 3 管理货架编码 └ device_code String 24 设备编码 └ is_horizontal Boolean true 是否水平 └ height String 60 高度 └ success Boolean true 是否成功 └ msg_info String 入参错误错误信息 └ msg_code String PARAM_ERROR 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaRexSkyeyeShelfLayoutQueryRequest req = new AlibabaRexSkyeyeShelfLayoutQueryRequest();
req.setShopCode("8028");
req.setMerchantCode("HM");
req.setCabinetCode("AC00004");
AlibabaRexSkyeyeShelfLayoutQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaRexSkyeyeShelfLayoutQueryRequest req = new AlibabaRexSkyeyeShelfLayoutQueryRequest();
req.ShopCode = "8028";
req.MerchantCode = "HM";
req.CabinetCode = "AC00004";
AlibabaRexSkyeyeShelfLayoutQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaRexSkyeyeShelfLayoutQueryRequest;
$req->setShopCode("8028");
$req->setMerchantCode("HM");
$req->setCabinetCode("AC00004");
$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.rex.skyeye.shelf.layout.query' \
-d 'partner_id=apidoc' \
-d 'sign=A520DED097E86653300C943DBD0CC4DD' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-05-17+19%3A26%3A17' \
-d 'v=2.0' \
-d 'cabinet_code=AC00004' \
-d 'merchant_code=HM' \
-d 'shop_code=8028'

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

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

req.shop_code="8028"
req.merchant_code="HM"
req.cabinet_code="AC00004"
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.rex.skyeye.shelf.layout.query");
add_param(pRequest,"shop_code","8028");
add_param(pRequest,"merchant_code","HM");
add_param(pRequest,"cabinet_code","AC00004");
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.rex.skyeye.shelf.layout.query', {
	'shop_code':'8028',
	'merchant_code':'HM',
	'cabinet_code':'AC00004'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_rex_skyeye_shelf_layout_query_response>
    <result>
        <data>
            <shelf_sku_detail_list>
                <shelf_sku_detail_list>
                    <z_face_num>1</z_face_num>
                    <layer_num>1</layer_num>
                    <sku_name>安格斯谷饲菲力牛排  120g</sku_name>
                    <pic_url>https://img.alicdn.com/imgextra/i2/263685747/O1CN012ICNLI1sKBJXR0GWo_!!263685747.jpg</pic_url>
                    <depth>7</depth>
                    <side_cap_x>1</side_cap_x>
                    <hole_num>1</hole_num>
                    <x_face_num>1</x_face_num>
                    <width>22</width>
                    <display_num>0</display_num>
                    <stack_cap_y>10</stack_cap_y>
                    <location_num>1</location_num>
                    <y_face_num>1</y_face_num>
                    <sku_code>444574025</sku_code>
                    <height>16</height>
                </shelf_sku_detail_list>
            </shelf_sku_detail_list>
            <shelf_detail_info>
                <shelf_code>LF4-B2</shelf_code>
                <depth>35</depth>
                <is_mirror>false</is_mirror>
                <width>200</width>
                <display_unit_code>WLD0006</display_unit_code>
                <hole_distance>5</hole_distance>
                <planogram_name>12345</planogram_name>
                <manage_shelf_code>3</manage_shelf_code>
                <device_code>24</device_code>
                <is_horizontal>true</is_horizontal>
                <height>60</height>
            </shelf_detail_info>
        </data>
        <success>true</success>
        <msg_info>入参错误</msg_info>
        <msg_code>PARAM_ERROR</msg_code>
    </result>
</alibaba_rex_skyeye_shelf_layout_query_response>

{
    "alibaba_rex_skyeye_shelf_layout_query_response":{
        "result":{
            "data":{
                "shelf_sku_detail_list":{
                    "shelf_sku_detail_list":[
                        {
                            "z_face_num":1,
                            "layer_num":1,
                            "sku_name":"安格斯谷饲菲力牛排  120g",
                            "pic_url":"https:\/\/img.alicdn.com\/imgextra\/i2\/263685747\/O1CN012ICNLI1sKBJXR0GWo_!!263685747.jpg",
                            "depth":"7",
                            "side_cap_x":"1",
                            "hole_num":1,
                            "x_face_num":1,
                            "width":"22",
                            "display_num":0,
                            "stack_cap_y":"10",
                            "location_num":1,
                            "y_face_num":1,
                            "sku_code":"444574025",
                            "height":"16"
                        }
                    ]
                },
                "shelf_detail_info":{
                    "shelf_code":"LF4-B2",
                    "depth":"35",
                    "is_mirror":false,
                    "width":"200",
                    "display_unit_code":"WLD0006",
                    "hole_distance":"5",
                    "planogram_name":"12345",
                    "manage_shelf_code":3,
                    "device_code":"24",
                    "is_horizontal":true,
                    "height":"60"
                }
            },
            "success":true,
            "msg_info":"入参错误",
            "msg_code":"PARAM_ERROR"
        }
    }
}

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.rex.skyeye.shelf.layout.query (查询门店前场货架完整陈列数据)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ