万店掌 开放平台 获取门店列表(请求头中必须有token参数，参数名为authenticator，该值从用户API中的登陆接口获得)
{ "idx": null }

open.shopweb.departments.getDeptListByPage （获取门店列表(请求头中必须有token参数，参数名为authenticator，该值从用户API中的登陆接口获得)）

获取门店列表(请求头中必须有token参数，参数名为authenticator，该值从用户API中的登陆接口获得)

接口描述 #

环境 接口方法 提交方式 是否需要签名 HTTP请求路由
正式环境 open.shopweb.departments.getDeptListByPage POST true http://cloudapi.ovopark.com/cloud.api

公共请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
_aid String 是 20 开放平台系统编号，固定为S107 S107
_akey String 是 20 万店掌开放平台分配给第三方的开发者key 认证平台开发者后获取
_mt String 是 100 接口名称 open.shopweb.departments.getDeptListByPage
_sm String 是 100 签名算法 md5,sha1 md5
_requestMode String 是 100 请求方式post,get POST
_version String 是 100 版本号 v1
_timestamp String 是 100 时间戳 yyyyMMddHHmmss格式
_sig String 是 32 签名token 根据签名算法生成，详情见签名算法规则
_format String 否 10 format类型 目前默认仅支持json

业务请求参数 #

参数 类型 是否必填 最大长度 描述 示例值
pageNumber		 int × 11 页数 1
pageSize		 int × 11 每页数量 1
shopIds		 string × 100 门店编号(多个用逗号隔开。非必填) 123,456
name		 string × 100 门店名称 测试

公共响应参数 #

参数 类型 最大长度 描述 示例值
stat JSON - 网关状态(具体参数描述如下：) 查看
stat.cid String 100 http请求的标识符
stat.code String 100 网关返回码
stat.codename String 100 网关返回码名称
stat.systime String Long 接口调用的当前时间
result String 100 接口返回提示信息
data JSON - 接口调用返回的业务信息(一般是json格式数据，具体数据格式会在业务返回参数中定义) 查看

业务返回参数 #

参数名称 类型 是否一定返回 返回最大长度 描述 示例值
total		 int × 11 门店总数 1
current		 int × 11 当前第几页 1
pages		 int × 11 页数 1
records		 JSON × 100 结果集 查看
    
id		 int × 11 【records】门店id 1
    
shopId		 string × 100 【records】门店编号 123
    
name		 string × 100 【records】门店名称 test
    
deviceCount		 int × 11 【records】IPC设备数量 1
    
latitude		 double × 100 【records】维度 1.00
    
longitude		 double × 100 【records】经度 1.00
    
score		 int × 11 【records】分数 1
    
pinyin		 string × 100 【records】门店拼音 test
    
pyName		 string × 100 【records】首字母 t
    
location		 int × 11 【records】门店区域 1
    
totalSale		 int × 11 【records】销售量 1
    
organizeId		 int × 11 【records】组织架构id S_1001
    
storeManId		 int × 11 【records】店长id 123
    
phone		 string × 100 【records】手机号 18511111111
    
address		 string × 100 【records】地址 江苏省苏州市
    
openStatus		 int × 11 【records】门店状态 0
    
storeArea		 int × 11 【records】门店面积 10
    
email		 string × 100 【records】邮箱 ceshi@162.com
    
openingDate		 string × 100 【records】开店时间 2022-07-30 00:00:00
size		 int × 11 每页数量 10

公共返回码 #

返回码名称 返回码 返回码描述 解决方案
SUCCESS 0 调用成功
KEY_NOTNULL 1 _akey和不能为空 接口调用时传入_akey参数
KEY_UNLAWFUL 2 _akey不合法 key是非法的,传入正确的key
KEY_HAS_EXPIRED 3 _akey已过期 请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL 4 _sm参数不能为空 接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST 5 _sm类型不存在 目前仅支持md5,sha1
SIGN_NOTNULL 6 _sig参数不能为空 接口调用时传入_sig参数
SIGN_WRONG 7 无效的签名，请检查参数和签名格式 _sig值根据签名算法生成
METHOD_NOTNULL 8 _mt参数不能为空 接口调用时传入_mt参数
METHOD_NOTEXIST_CODE 9 _mt对应的方法名不存在或未注册进服务 检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL 10 _requestMode参数不能为空 接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL 11 _aid参数不能为空 接口调用时传入_aid参数
APPLICATIONID_NOTSAME 12 _aid与当前key不匹配 _aid与_akey必须一一对应
VERSION_NOTNULL 13 _version版本号不能为空 接口调用时传入_version参数
TIMESTAMP_NOTNULL 14 _timestamp时间戳不能为空 接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR 15 _timestamp时间戳格式化错误 按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME 16 _timestamp已失效 _timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST 17 _format类型不存在 目前仅支持json(默认),xml
API_CALL_REPEAT -100 接口重复调用 接口平台调用异常
API_SYSTEM_CALL_ERROR -500 api调用失败，系统发生异常 接口平台调用异常
UNKNOWN_ERROR -999 开放平台系统异常 重新发起请求

业务返回码 #

返回码名称 返回码 返回码描述
BUSINESS_PLATFORM_UNBOUND		 103001 业务平台未做绑定,请联系客服
DATA_NOT_NULL		 103002 必填字段不能为空
PARAMETER_VALIDATE_ERROR		 103004 参数效验异常
IDENTITY_INFORMATION_WRONG		 103005 身份信息有误,_akey与企业id不匹配
SERVICE_TIMEOUT		 103066 服务请求超时
API_SYSTEM_ERROR		 103999 api服务未知异常