当前位置: API文档
shop.php(查询店铺)
奇门接口url:wdt.shop.query
1.接口说明
1.1 接口描述:批量获取旺店通ERP内店铺档案信息 |
1.2 适用版本:网页版 |
1.3 全量获取:该接口是全量获取数据或按照shop_id获取,无法按照时间段增量获取数据。 |
2.调用场景
2.1 暂无 |
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
---|---|
测试环境 | https://openapitest.huice.com/openapi/shop.php |
正式环境 | https://openapi.huice.com/openapi/shop.php |
3.2 公共请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,申请流程单击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
3.3 业务请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
店铺编号 | shop_id | int | 10 | 否 | 代表店铺所有属性的唯一编码,用于店铺区分, ERP内支持自定义(ERP店铺界面设置),用于获取指定店铺数据信息 |
平台ID | platform_id | smallint | 6 | 否 | 平台ID详情介绍单击这里 |
平台ID(批量) | platform_ids | varchar | 否 | 批量指定平台ID获取(多个平台ID之间用英文逗号隔开) | |
分页大小 | page_size | int | 10 | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为30,使用举例单击这里 |
页号 | page_no | int | 10 | 否 | 不传值默认从0页开始 |
是否停用 | is_disabled | varchar | 否 | 0未停用 1停用 不传默认为0 |
4.响应参数
4.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
shoplist | data[ ] | 是 | 店铺详情数据节点 |
4.2 业务响应参数
shoplist
shoplist | |||||
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
平台ID | platform_id | smallint | 6 | 是 | 平台ID详情介绍单击这里 |
子平台ID | sub_platform_id | tinyint | 4 | 是 | 子平台ID |
店铺ID | shop_id | smallint | 6 | 是 | 店铺列表主键 |
店铺名称 | shop_name | varchar | 128 | 是 | ERP店铺界面的店铺名称 |
平台授权账号ID | account_id | varchar | 40 | 是 | 平台授权账号ID(所有平台返回为空值) |
平台账号 | account_nick | varchar | 128 | 是 | 平台授权账号昵称(所有平台返回为空值) |
授权状态 | auth_state | varchar | 40 | 是 | 授权状态,0未授权 1已授权 2授权失效 3授权停用 |
是否启用推送 | push_rds_id | varchar | 40 | 是 | 是否启用推送 0不推送 其它值对应RDS服务器 |
邮件 | varchar | 64 | 是 | 邮件 | |
最后修改时间 | modified | datetime | 11 | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss |
创建时间 | created | datetime | 11 | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss |
店铺简称 | shop_short_name | varchar | 128 | 否 | |
是否停用 | is_disabled | bool | 1 | 是 | false 否 true 是 true 标识已经停用了 |
主店铺ID | main_shop_id | int | 否 | 只有小时达门店会有主店铺ID ,如果是小时达平台例如抖音小时达,有主店铺ID代表是子店铺 | |
平台门店ID | platform_store_id | varchar | 64 | 否 | 只有小时达店铺会有, 表示平台的门店id,例如抖音小时达后台的门店Id |