当前位置: API文档

shop.php(查询店铺

¥标准

1.接口说明  

   1.1 接口描述:批量获取旺店通ERP内店铺档案信息            
   1.2 适用版本:客户端 V2.4.5.0及以上版本      
   1.3 全量获取:该接口是全量获取数据或按照shop_no获取,无法按照时间段增量获取数据。            

2.调用场景 

  2.1 暂无            

3.请求参数说明 

   3.1 请求地址

环境HTTP地址
测试环境https://sandbox.wangdian.cn/openapi2/shop.php
正式环境https://api.wangdian.cn/openapi2/shop.php

  3.2公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里

  3.3业务请求参数

名称字段类型长度
必须描述
店铺编号shop_novarchar40代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),用于获取指定店铺数据信息
平台IDplatform_idsmallint6平台ID详情介绍单击这里
平台ID(批量)platform_idsvarchar
批量指定平台ID获取(多个平台ID之间用英文逗号隔开)
分页大小page_sizeint10每页返回的数据条数,输入值范围1~100,不传本参数输入值默认为30,使用举例单击这里
页号page_noint10不传值默认从0页开始
是否停用
is_disabledvarchar


0未停用 1停用  不传默认为0

4.响应参数说明

  4.1公共响应参数

名称字段类型长度
必须描述
错误码codeint40状态码:0表示成功,其他表示失败
店铺l列表节点shoplistdata[ ]
店铺详情数据节点

  4.2业务响应参数

   shoplist

名称字段类型长度
必须描述
平台IDplatform_idsmallint6平台ID详情介绍单击这里
子平台IDsub_platform_idtinyint4子平台ID
店铺IDshop_idsmallint6店铺列表主键
店铺编号shop_novarchar20代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置)
店铺名称shop_namevarchar128ERP店铺界面的店铺名称
平台授权账号IDaccount_idvarchar40平台授权账号ID(所有平台返回为空值)
平台账号account_nickvarchar128平台授权账号昵称(所有平台返回为空值)
省份IDprovinceint11ERP店铺设置中的省份ID,按照城市代码表中对应城市代码进行返回
城市ID
cityint11ERP店铺设置中的城市ID,按照城市代码表中对应城市代码进行返回
区县ID
districtint11ERP店铺设置中的区县ID,按照城市代码表中对应城市代码进行返回
省份province_namevarchar50ERP店铺设置中的省份名称信息
城市city_namevarchar50ERP店铺设置中的城市名称信息
区县district_namevarchar50ERP店铺设置中的区县名称信息
地址addressvarchar255ERP店铺设置中的地址信息
联系人contactvarchar32ERP店铺设置中的联系人信息
邮编zipvarchar16ERP店铺设置中的邮编信息
移动电话mobilevarchar40ERP店铺设置中的手机信息
固定电话telnovarchar40ERP店铺设置中的电话信息
备注
remark
varchar255
ERP店铺设置中的备注信息
账款账号
pay_account_idvarchar40
账款账号,如支付宝,财付通
授权状态
auth_statevarchar40
授权状态,0未授权 1已授权 2授权失效  3授权停用
是否启用推送
push_rds_idvarchar40
是否启用推送 0不推送 其它值对应RDS服务器
支付宝授权状态
pay_auth_statevarchar40
支付宝授权状态 0未授权 1已授权 2授权失效  3授权停用
授权时间
auth_timedatetime

API授权日期   格式:yyyy-MM-dd HH:mm:ss
session过期时间
expire_timedatetime

session过期时间    格式:yyyy-MM-dd HH:mm:ss
refresh_token过期时间re_expire_timedatetime

refresh_token过期时间     格式:yyyy-MM-dd HH:mm:ss
冻结授权时间freeze_auth_tovarchar
11
冻结授权到此时间为止(unix时间戳)
物流宝订单
wms_checkvarchar
1
检查是否是物流宝订单
使用物流id
logistics_idvarchar
11
使用物流公司0表示按物流策略来计算
货到付款物流cod_logistics_idvarchar
11
货到付款物流
国家countryvarchar
11
国家
地址库idaddress_idvarchar
11
地址库id
邮件emailvarchar
64
邮件
店铺网址websitevarchar
1024
店铺网址
自定义属性1
prop1
varchar
255
自定义属性1
自定义属性2prop2varchar255自定义属性2
是否禁止自动抓取订单is_undownload_tradevarchar1是否禁止自动抓取订单
服务商idinvoice_provider_idvarchar4服务商id,电子发票专用
分组idgroup_idvarchar11分组id,初始等于0
米氏抢单开关
is_hold_enabledvarchar
1
米氏抢单开关
递交中禁止店铺自动合并
is_nomergevarchar
1
递交中禁止店铺自动合并
递交中禁止店铺自动拆分
is_nosplitvarchar
1
递交中禁止店铺自动拆分
递交中是否禁用货品指定仓库策略is_forbidden_setwarebygoodsvarchar
1
递交中是否禁用货品指定仓库策略
货品指定方式is_setwarebygoodsvarchar
1
货品指定方式 0无 1指定仓库 2指定仓库地址
自定义字段cust_datavarchar
255
自定义字段
是否转入预订单is_topreordervarchar
11
是否转入预订单,默认0
是否停用is_disabledvarchar
1
是否停用
非淘店铺关联淘宝店铺
taobao_shop_idvarchar
4
非淘宝店铺关联淘宝店铺,电子发票专用
收款方id
invoice_payee_idvarchar
4
收款方id,电子发票专用
纸质服务商id
paper_invoice_provider_idvarchar
4
纸质服务商id
物流同步延迟小时数
logistics_sync_delayvarchar
4
物流同步延迟小时数
店铺禁用物流列表
forbidden_logistics_listvarchar
512
店铺禁用物流列表
店铺展示顺序
shop_priorityvarchar
11
店铺展示顺序
大单的单品数量最低限制great_deal_limitvarchar
11
大单的单品数量最低限制,为0代表不使用
大单指定仓库great_deal_warehousevarchar
11
大单指定仓库
最后修改时间modifieddatetime
11
最后修改时间    格式:yyyy-MM-dd HH:mm:ss
创建时间
created
datetime
11
创建时间    格式:yyyy-MM-dd HH:mm:ss

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/shop.php';
    
    $c->putApiParam('shop_no', 'api_test');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.basic;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

public class ShopQuery {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url");
        //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看,测试环境url=https://sandbox.wangdian.cn/openapi2/
        //调用正式环境时请将sid、appkey、appsecret切换为实际参数,参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看,调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/
        
        Map<String, String> params = new HashMap<String, String>();
        params.put("shop_no", "ghs2test");

        try {
            String response = client.execute("shop.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace LogisticsQuery
{
    class LogisticsQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/shop.php";

            client.putParams("shop_no", "shop_no");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
python
import WdtClient

t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/')
params = {}
params.update({"shop_no": '123'})
params.update({"page_size": '100'})
params.update({"page_no": '0'})

response = t.execute("shop.php", params)
print(response)

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": "0",
    "total_count": "1",
    "shoplist": [{
        "platform_id": "127",
        "sub_platform_id": "0",
        "shop_id": "66",
        "shop_no": "xyp2test",
        "shop_name": "小鹏测试店铺",
        "account_id": "",
        "account_nick": "",
        "province": "110000",
        "city": "110100",
        "district": "110108",
        "address": "花园路13号",
        "contact": "小鹏",
        "zip": "100089 ",
        "mobile": "13500001111",
        "telno": "010-00000000",
        "remark": "123"
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 1007,
    "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 "
}


常用工具