调用DescribePlanogramShelves查询门店下所有的货架信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribePlanogramShelves

系统规定参数。取值：DescribePlanogramShelves。
StoreId String 是 s-dxsxx****

门店ID或商家自定义门店ID。
PageNumber Integer 否 1

分页参数：当前页码，默认值1。
PageSize Integer 否 10

分页参数：每页显示条数，默认值10。

返回数据

名称 类型 示例值 描述
Code String -1001

内部错误码。
DynamicCode String PlatformResponseError.%s

动态错误码。
DynamicMessage String The specified store %s does not exist.

动态消息。
ErrorCode String MandatoryParameters

错误码。
ErrorMessage String The specified resource type is invalid.

错误消息。
Message String success

消息。
PageNumber Integer 1

分页参数：当前页码。
PageSize Integer 10

分页参数：每页显示条数。
RequestId String E69C8998-1787-4999-8C75-D663FF1173CF

请求ID。
ShelfInfos Array

货架信息列表。
BeMatch Boolean false

该货架上各个货位上的陈列信息是否和价签绑定信息是否完全符合。
Category String 红酒

货架属性：类别，是区域的子属性
LayerInfos Array

层信息列表。
Layer Integer 1

层号。
Shelf String 20200201

货架号。
ShelfType String SHELF_TYPE_NORMAL

货架属性，返回值：

  • SHELF_TYPE_NORMAL：普通的陈列货架
  • SHELF_TYPE_NFC_RAIL：绑定NFC导轨的陈列货架
  • SHELF_TYPE_OSD：OSD货架。
Zone String 区域

货架属性：区域。
StoreId String s-dxsxx****

门店ID。
Success Boolean true

请求成功与否标识。
TotalCount Integer 200

总条数。

示例

请求示例

http(s)://cloudesl.cn-hangzhou.aliyuncs.com/?Action=DescribePlanogramShelves
&StoreId=s-dxsxx****
&<公共请求参数>

正常返回示例

XML 格式 

<ShelfInfos>
    <ShelfType>SHELF_TYPE_NORMAL</ShelfType>
    <Shelf>20200408</Shelf>
    <LayerInfos>
        <Layer>1</Layer>
    </LayerInfos>
    <BeMatch>false</BeMatch>
</ShelfInfos>
<ShelfInfos>
    <ShelfType>SHELF_TYPE_NFC_RAIL</ShelfType>
    <Shelf>20200409</Shelf>
    <LayerInfos>
        <Layer>1</Layer>
    </LayerInfos>
    <BeMatch>false</BeMatch>
</ShelfInfos>
<RequestId>321756E8-7B7C-4A72-B947-E141EF61C069</RequestId>
<PageSize>10</PageSize>
<Success>true</Success>
<TotalCount>2</TotalCount>
<StoreId>s-siiiqcpnhs</StoreId>
<PageNumber>1</PageNumber>

JSON 格式 

{"ShelfInfos":[{"Category":"红酒","ShelfType":"SHELF_TYPE_NORMAL","Zone":"区域","Shelf":"20200201","BeMatch":"false"},{"LayerInfos":[{"Layer":"1"}]}],"Message":"success","RequestId":"E69C8998-1787-4999-8C75-D663FF1173CF","PageSize":"10","DynamicMessage":"The specified store %s does not exist.","Code":"-1001","Success":"true","TotalCount":"200","StoreId":"s-dxsxx****","PageNumber":"1","DynamicCode":"PlatformResponseError.%s","ErrorCode":"MandatoryParameters","ErrorMessage":"The specified resource type is invalid."}

错误码

访问错误中心查看更多错误码。