当前位置: API文档
shop.php(查询店铺)
1.接口说明
1.1 接口描述:批量获取旺店通ERP内店铺档案信息 |
1.2 适用版本:客户端 V2.4.5.0及以上版本 |
1.3 全量获取:该接口是全量获取数据或按照shop_no获取,无法按照时间段增量获取数据。 |
2.调用场景
2.1 暂无 |
3.请求参数说明
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/shop.php |
正式环境 | https://api.wangdian.cn/openapi2/shop.php |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | 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输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺编号 | shop_no | varchar | 40 | 否 | 代表店铺所有属性的唯一编码,用于店铺区分,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.响应参数说明
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
店铺l列表节点 | shoplist | data[ ] | 是 | 店铺详情数据节点 |
shoplist
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
平台ID | platform_id | smallint | 6 | 是 | 平台ID详情介绍单击这里 |
子平台ID | sub_platform_id | tinyint | 4 | 是 | 子平台ID |
店铺ID | shop_id | smallint | 6 | 是 | 店铺列表主键 |
店铺编号 | shop_no | varchar | 20 | 是 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置) |
店铺名称 | shop_name | varchar | 128 | 是 | ERP店铺界面的店铺名称 |
平台授权账号ID | account_id | varchar | 40 | 是 | 平台授权账号ID(所有平台返回为空值) |
平台账号 | account_nick | varchar | 128 | 是 | 平台授权账号昵称(所有平台返回为空值) |
省份ID | province | int | 11 | 是 | ERP店铺设置中的省份ID,按照城市代码表中对应城市代码进行返回 |
城市ID | city | int | 11 | 是 | ERP店铺设置中的城市ID,按照城市代码表中对应城市代码进行返回 |
区县ID | district | int | 11 | 是 | ERP店铺设置中的区县ID,按照城市代码表中对应城市代码进行返回 |
省份 | province_name | varchar | 50 | 是 | ERP店铺设置中的省份名称信息 |
城市 | city_name | varchar | 50 | 是 | ERP店铺设置中的城市名称信息 |
区县 | district_name | varchar | 50 | 是 | ERP店铺设置中的区县名称信息 |
地址 | address | varchar | 255 | 是 | ERP店铺设置中的地址信息 |
联系人 | contact | varchar | 32 | 是 | ERP店铺设置中的联系人信息 |
邮编 | zip | varchar | 16 | 是 | ERP店铺设置中的邮编信息 |
移动电话 | mobile | varchar | 40 | 是 | ERP店铺设置中的手机信息 |
固定电话 | telno | varchar | 40 | 是 | ERP店铺设置中的电话信息 |
备注 | remark | varchar | 255 | 是 | ERP店铺设置中的备注信息 |
账款账号 | pay_account_id | varchar | 40 | 是 | 账款账号,如支付宝,财付通 |
授权状态 | auth_state | varchar | 40 | 是 | 授权状态,0未授权 1已授权 2授权失效 3授权停用 |
是否启用推送 | push_rds_id | varchar | 40 | 是 | 是否启用推送 0不推送 其它值对应RDS服务器 |
支付宝授权状态 | pay_auth_state | varchar | 40 | 是 | 支付宝授权状态 0未授权 1已授权 2授权失效 3授权停用 |
授权时间 | auth_time | datetime | 是 | API授权日期 格式:yyyy-MM-dd HH:mm:ss | |
session过期时间 | expire_time | datetime | 是 | session过期时间 格式:yyyy-MM-dd HH:mm:ss | |
refresh_token过期时间 | re_expire_time | datetime | 是 | refresh_token过期时间 格式:yyyy-MM-dd HH:mm:ss | |
冻结授权时间 | freeze_auth_to | varchar | 11 | 是 | 冻结授权到此时间为止(unix时间戳) |
物流宝订单 | wms_check | varchar | 1 | 是 | 检查是否是物流宝订单 |
使用物流id | logistics_id | varchar | 11 | 是 | 使用物流公司0表示按物流策略来计算 |
货到付款物流 | cod_logistics_id | varchar | 11 | 是 | 货到付款物流 |
国家 | country | varchar | 11 | 是 | 国家 |
地址库id | address_id | varchar | 11 | 是 | 地址库id |
邮件 | varchar | 64 | 是 | 邮件 | |
店铺网址 | website | varchar | 1024 | 是 | 店铺网址 |
自定义属性1 | prop1 | varchar | 255 | 是 | 自定义属性1 |
自定义属性2 | prop2 | varchar | 255 | 是 | 自定义属性2 |
是否禁止自动抓取订单 | is_undownload_trade | varchar | 1 | 是 | 是否禁止自动抓取订单 |
服务商id | invoice_provider_id | varchar | 4 | 是 | 服务商id,电子发票专用 |
分组id | group_id | varchar | 11 | 是 | 分组id,初始等于0 |
米氏抢单开关 | is_hold_enabled | varchar | 1 | 是 | 米氏抢单开关 |
递交中禁止店铺自动合并 | is_nomerge | varchar | 1 | 是 | 递交中禁止店铺自动合并 |
递交中禁止店铺自动拆分 | is_nosplit | varchar | 1 | 是 | 递交中禁止店铺自动拆分 |
递交中是否禁用货品指定仓库策略 | is_forbidden_setwarebygoods | varchar | 1 | 是 | 递交中是否禁用货品指定仓库策略 |
货品指定方式 | is_setwarebygoods | varchar | 1 | 是 | 货品指定方式 0无 1指定仓库 2指定仓库地址 |
自定义字段 | cust_data | varchar | 255 | 是 | 自定义字段 |
是否转入预订单 | is_topreorder | varchar | 11 | 是 | 是否转入预订单,默认0 |
是否停用 | is_disabled | varchar | 1 | 是 | 是否停用 |
非淘店铺关联淘宝店铺 | taobao_shop_id | varchar | 4 | 是 | 非淘宝店铺关联淘宝店铺,电子发票专用 |
收款方id | invoice_payee_id | varchar | 4 | 是 | 收款方id,电子发票专用 |
纸质服务商id | paper_invoice_provider_id | varchar | 4 | 是 | 纸质服务商id |
物流同步延迟小时数 | logistics_sync_delay | varchar | 4 | 是 | 物流同步延迟小时数 |
店铺禁用物流列表 | forbidden_logistics_list | varchar | 512 | 是 | 店铺禁用物流列表 |
店铺展示顺序 | shop_priority | varchar | 11 | 是 | 店铺展示顺序 |
大单的单品数量最低限制 | great_deal_limit | varchar | 11 | 是 | 大单的单品数量最低限制,为0代表不使用 |
大单指定仓库 | great_deal_warehouse | varchar | 11 | 是 | 大单指定仓库 |
最后修改时间 | modified | datetime | 11 | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss |
创建时间 | created | datetime | 11 | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss |
5.请求示例
6.响应示例
6.2 异常响应示例
JSON | { "code": 1007, "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 " } |