查询门店基础信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeStores | 系统规定参数。取值:DescribeStores。 |
UserStoreCode | String | 否 | 123456 | 商家自定义门店ID。 |
PageNumber | Integer | 否 | 1 | 分页参数:当前页码,默认值1。 |
PageSize | Integer | 否 | 10 | 分页参数:每页显示条数,默认值10。 |
StoreName | String | 否 | 天猫超市 | 门店名称。 |
ToDate | String | 否 | 2020-03-08T02:58:16Z | 门店创建时间:结束时间。 |
StoreId | String | 否 | s-dxsxx**** | 门店ID。 |
FromDate | String | 否 | 2020-03-06T02:58:16Z | 门店创建时间:开始时间。 |
ExtraParams | String | 否 | {} | 系统保留字段,请忽略; |
TemplateVersion | String | 否 | 1.1.0 | 门店配置的模板版本号; |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | E69C8998-1787-4999-8C75-D663FF1173CF | 请求ID。 |
ErrorMessage | String | The specified resource type is invalid. | 错误消息。 |
Success | Boolean | true | 请求成功与否标识。 |
ErrorCode | String | MandatoryParameters | 错误码。 |
Code | String | -1001 | 后端错误码。 |
Message | String | success | 消息。 |
DynamicMessage | String | The specified store %s does not exist. | 动态消息。 |
PageNumber | Integer | 1 | 分页参数:当前页码。 |
PageSize | Integer | 10 | 分页参数:每页显示条数。 |
TotalCount | Integer | 100 | 总条数。 |
DynamicCode | String | PlatformResponseError.%s | 动态错误码。 |
Stores | Array of StoreInfo | 门店信息列表。 |
|
StoreId | String | s-dxsxx**** | 门店ID。 |
ParentId | String | s-aasx**** | 父门店ID。 |
TimeZone | String | GMT+08:00 | 门店时区配置 |
GmtCreate | String | 2020-03-06T02:58:16Z | 创建时间。 |
StoreName | String | 天猫旗舰店 | 门店名称。 |
GmtModified | String | 2020-03-06T02:58:16Z | 修改时间。 |
TemplateVersion | String | 1.1.0 | 门店模板版本号; |
Level | String | 1级 | 级别。 |
Phone | String | 0571-5666888 | 门店所在监督工商局的监督电话。 |
UserStoreCode | String | 20200201 | 商家自定义门店ID。 |
BarCodeEncode | Integer | 0 | 条形码编码方式:0:Code128 ,1:EAN13(默认0) |
AutoUnbindOfflineEsl | Boolean | true | 是否启用自动解绑离线价签 |
AutoUnbindDays | Integer | 1 | 自动解绑离线价签条件-价签离线天数 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeStores
&UserStoreCode=123456
&PageNumber=1
&PageSize=10
&StoreName=天猫超市
&ToDate=2020-03-08T02:58:16Z
&StoreId=s-dxsxx****
&FromDate=2020-03-06T02:58:16Z
&ExtraParams={}
&TemplateVersion=1.1.0
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeStoresResponse>
<RequestId>E69C8998-1787-4999-8C75-D663FF1173CF</RequestId>
<ErrorMessage>The specified resource type is invalid.</ErrorMessage>
<Success>true</Success>
<ErrorCode>MandatoryParameters</ErrorCode>
<Code>-1001</Code>
<Message>success</Message>
<DynamicMessage>The specified store %s does not exist.</DynamicMessage>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>100</TotalCount>
<DynamicCode>PlatformResponseError.%s</DynamicCode>
<Stores>
<StoreId>s-dxsxx****</StoreId>
<ParentId>s-aasx****</ParentId>
<TimeZone>GMT+08:00</TimeZone>
<GmtCreate>2020-03-06T02:58:16Z</GmtCreate>
<StoreName>天猫旗舰店</StoreName>
<GmtModified>2020-03-06T02:58:16Z</GmtModified>
<TemplateVersion>1.1.0</TemplateVersion>
<Level>1级</Level>
<Phone>0571-5666888</Phone>
<UserStoreCode>20200201</UserStoreCode>
<BarCodeEncode>0</BarCodeEncode>
<AutoUnbindOfflineEsl>true</AutoUnbindOfflineEsl>
<AutoUnbindDays>1</AutoUnbindDays>
</Stores>
</DescribeStoresResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E69C8998-1787-4999-8C75-D663FF1173CF",
"ErrorMessage" : "The specified resource type is invalid.",
"Success" : true,
"ErrorCode" : "MandatoryParameters",
"Code" : -1001,
"Message" : "success",
"DynamicMessage" : "The specified store %s does not exist.",
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 100,
"DynamicCode" : "PlatformResponseError.%s",
"Stores" : {
"StoreId" : "s-dxsxx****",
"ParentId" : "s-aasx****",
"TimeZone" : "GMT+08:00",
"GmtCreate" : "2020-03-06T02:58:16Z",
"StoreName" : "天猫旗舰店",
"GmtModified" : "2020-03-06T02:58:16Z",
"TemplateVersion" : "1.1.0",
"Level" : "1级",
"Phone" : "0571-5666888",
"UserStoreCode" : 20200201,
"BarCodeEncode" : 0,
"AutoUnbindOfflineEsl" : true,
"AutoUnbindDays" : 1
}
}
错误码
访问错误中心查看更多错误码。