查询门店报表数据。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /QueryShopIndex HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
Country String FormData CN

国家字段,CN:中国,SG:新加坡

ShopIdList Array of String FormData code10

门店id

返回数据

名称 类型 示例值 描述
Success Boolean true

成功标志

Message String success

说明

Code String success

状态码

HttpStatusCode Integer 200

http状态码

RequestId String 1B0723A1-9B6B-57D5-A2D4-AA7E56F04E3D

请求ID

Data Object

The returned data.

ShopScheduleIndex Object

门店排期数据

ScheduleNum Integer 7810

排期总数

ScheduleShopNum Integer 2800

覆盖门店数

SuccessRate Float 92.89%

门店下发成功率

FailShopNum Integer 9

下发失败门店数

CostTime double 362

下发时间单位:秒

FailShops Array of FailShops

错误门店列表

ShopId String shop_x3isp2

门店ID

ShopName String 延安西路店

门店名称

ShopIndex Object

门店报表数据

ShopTotal Integer 10310

门店总数

NetWorkShopNum Integer 890

已入网门店数

InstalledShopNum Integer 9801

已安装门店数

NotWorkShopNum Integer 780

未入网门店数

UpholdShopNum Integer 560

维护中门店数

NormalShopNum Integer 10201

正常门店数

FaultShopNum Integer 210

故障门店数

HighFreqFaultShopNum Integer 12

频繁故障门店数

示例

请求示例

POST /QueryShopIndex HTTP/1.1
Host:cd.aliyuncs.com
Content-Type:application/json

Country=CN&ShopIdList=["code10"]

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryShopIndexResponse>
    <Success>true</Success>
    <Message>success</Message>
    <Code>success</Code>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>1B0723A1-9B6B-57D5-A2D4-AA7E56F04E3D</RequestId>
    <Data>
        <ShopScheduleIndex>
            <ScheduleNum>7810</ScheduleNum>
            <ScheduleShopNum>2800</ScheduleShopNum>
            <FailShopNum>9</FailShopNum>
            <CostTime>362</CostTime>
            <FailShops>
                <ShopId>shop_x3isp2</ShopId>
                <ShopName>延安西路店</ShopName>
            </FailShops>
        </ShopScheduleIndex>
        <ShopIndex>
            <ShopTotal>10310</ShopTotal>
            <NetWorkShopNum>890</NetWorkShopNum>
            <InstalledShopNum>9801</InstalledShopNum>
            <NotWorkShopNum>780</NotWorkShopNum>
            <UpholdShopNum>560</UpholdShopNum>
            <NormalShopNum>10201</NormalShopNum>
            <FaultShopNum>210</FaultShopNum>
            <HighFreqFaultShopNum>12</HighFreqFaultShopNum>
        </ShopIndex>
    </Data>
</QueryShopIndexResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "Message" : "success",
  "Code" : "success",
  "HttpStatusCode" : 200,
  "RequestId" : "1B0723A1-9B6B-57D5-A2D4-AA7E56F04E3D",
  "Data" : {
    "ShopScheduleIndex" : {
      "ScheduleNum" : 7810,
      "ScheduleShopNum" : 2800,
      "FailShopNum" : 9,
      "CostTime" : 362,
      "FailShops" : {
        "ShopId" : "shop_x3isp2",
        "ShopName" : "延安西路店"
      }
    },
    "ShopIndex" : {
      "ShopTotal" : 10310,
      "NetWorkShopNum" : 890,
      "InstalledShopNum" : 9801,
      "NotWorkShopNum" : 780,
      "UpholdShopNum" : 560,
      "NormalShopNum" : 10201,
      "FaultShopNum" : 210,
      "HighFreqFaultShopNum" : 12
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Params.Illegal The request parameters are invalid. 请求入参非法
401 Unauthorized You are not authorized to perform this operation. 未授权的请求
403 Forbidden This request is prohibited. 请求被禁止
503 Service.Unavailable The service is unavailable. Please try again later. 服务当前暂不可用,请稍后重试

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