调用DescribePlanogramPositions查询陈列货位信息。

调试

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

请求参数

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

系统规定参数。取值:DescribePlanogramPositions。

Shelf String 20200201

陈列系统的货架号。

StoreId String s-dxsx****

门店ID或商家自定义门店ID。

Layer Integer 1

陈列系统的层号。

返回数据

名称 类型 示例值 描述
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.

错误消息。

LayerInfos Array

层信息列表。

Layer Integer 1

层号。

LayerOrigin String TOP_LEFT

层的起始点,返回值:

  • TOP_LEFT:左上角
  • BOTTOM_LEFT:左下角。
RailCode String aabbccddeeff

导轨编号。

ShelfPositionInfos Array

货位信息列表。

Column String 1

逻辑列。

Depth Float 50

货位的深度,单位cm。

Facing Integer 1

商品的牌面数。

ItemBarCode String 690560583****

商品条码。

ItemTitle String 纯牛奶

商品名称。

OffsetFrom Float 00

商品的左偏移距离,单位cm。

OffsetTo Float 50

商品的右偏移距离,单位cm。

Message String success

消息。

RequestId String E69C8998-1787-4999-8C75-D663FF1173CF

请求ID。

Shelf String 20200201

货架号。

ShelfType String SHELF_TYPE_NORMAL

货架属性,返回值:

SHELF_TYPE_NORMAL:普通的陈列货架

SHELF_TYPE_NFC_RAIL:绑定NFC导轨的陈列货架。

StoreId String s-dxsxx****

门店ID。

Success Boolean true

请求成功与否标识。

示例

请求示例

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

正常返回示例

XML 格式

<DescribePlanogramPositionsResponse>
  <StoreId>s-cttas****</StoreId>
  <RequestId>4C703BFE-697D-4D35-94C1-A17139DC7DC9</RequestId>
  <Shelf>20200306</Shelf>
  <LayerInfos>
        <LayerOrigin>TOP_LEFT</LayerOrigin>
        <Layer>1</Layer>
        <ShelfPositionInfos>
              <Facing>2</Facing>
              <OffsetTo>100</OffsetTo>
              <Column>1</Column>
              <OffsetFrom>50</OffsetFrom>
              <Depth>2</Depth>
        </ShelfPositionInfos>
        <ShelfPositionInfos>
              <Facing>2</Facing>
              <OffsetTo>100</OffsetTo>
              <Column>2</Column>
              <OffsetFrom>50</OffsetFrom>
              <Depth>2</Depth>
        </ShelfPositionInfos>
        <ShelfPositionInfos>
              <Facing>2</Facing>
              <OffsetTo>100</OffsetTo>
              <Column>3</Column>
              <OffsetFrom>50</OffsetFrom>
              <Depth>2</Depth>
        </ShelfPositionInfos>
  </LayerInfos>
  <LayerInfos>
        <LayerOrigin>TOP_LEFT</LayerOrigin>
        <Layer>2</Layer>
        <ShelfPositionInfos>
              <Facing>1</Facing>
              <OffsetTo>50</OffsetTo>
              <Column>1</Column>
              <ItemTitle>光明纯牛奶</ItemTitle>
              <ItemBarCode>69056058****</ItemBarCode>
              <OffsetFrom>0</OffsetFrom>
              <Depth>1</Depth>
        </ShelfPositionInfos>
        <ShelfPositionInfos>
              <Facing>2</Facing>
              <OffsetTo>100</OffsetTo>
              <Column>3</Column>
              <OffsetFrom>50</OffsetFrom>
              <Depth>2</Depth>
        </ShelfPositionInfos>
  </LayerInfos>
  <Success>true</Success>
</DescribePlanogramPositionsResponse>

JSON 格式

{
  "StoreId": "s-cttas****",
  "RequestId": "4C703BFE-697D-4D35-94C1-A17139DC7DC9",
  "Shelf": "20200306",
  "LayerInfos": [
    {
      "LayerOrigin": "TOP_LEFT",
      "Layer": 1,
      "ShelfPositionInfos": [
        {
          "Facing": 2,
          "OffsetTo": 100,
          "Column": "1",
          "OffsetFrom": 50,
          "Depth": 2
        },
        {
          "Facing": 2,
          "OffsetTo": 100,
          "Column": "2",
          "OffsetFrom": 50,
          "Depth": 2
        },
        {
          "Facing": 2,
          "OffsetTo": 100,
          "Column": "3",
          "OffsetFrom": 50,
          "Depth": 2
        }
      ]
    },
    {
      "LayerOrigin": "TOP_LEFT",
      "Layer": 2,
      "ShelfPositionInfos": [
        {
          "Facing": 1,
          "OffsetTo": 50,
          "Column": "1",
          "ItemTitle": "光明纯牛奶",
          "ItemBarCode": "69056058****",
          "OffsetFrom": 0,
          "Depth": 1
        },
        {
          "Facing": 2,
          "OffsetTo": 100,
          "Column": "3",
          "OffsetFrom": 50,
          "Depth": 2
        }
      ]
    }
  ],
  "Success": true
}

错误码

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