当前位置: API文档

warehouse_query.php(查询仓库)

¥标准

1.接口说明

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

2.调用场景

  2.1 暂无

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/warehouse_query.php
正式环境http://api.wangdian.cn/openapi2/warehouse_query.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 业务请求参数

名称字段类型长度
必须描述
仓库编号warehouse_novarchar(40)代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),用于获取指定仓库数据信息(不支持一次推送多个仓库编码)
仓库类型typetinyint(4)1普通仓库 2自动流传外部 3京东仓储 4科捷 5百世物流 6 SKU360 7通天晓 8中联网仓 9顺丰仓储 10网仓2号 11奇门仓储 12旺店通仓储 13心怡仓储 14力威仓储 127其它(不传默认返回全部类型)
子类型sub_typedate
仓库子类型(针对其它仓储 1米氏实体店 2 线下虚拟店)
分页大小page_sizeint10每页返回的数据条数,输入值范围1~30,不传本参数,输入值默认为30,使用举例单击这里
页号page_noint10不传值默认从0页开始

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint40状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint10只有page_no = 0 时,才返回的符合条件的数据总条数,用来分页
仓库详情数据节点warehousedata
仓库详情数据节点

   4.2 业务响应参数

名称字段类型长度
必须描述
仓库编号warehouse_novarchar40代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),用于获取指定仓库数据信息
仓库名称namevarchar64ERP仓库界面的仓库名称
仓库类型warehouse_typetinyint4(0不限 1普通仓库 2自动流传外部 3京东仓储 4科捷 5百世物流 6 SKU360 7通天晓 8中联网仓 9顺丰仓储 10网仓2号 11奇门仓储 12旺店通仓储 13心怡仓储 14力威仓储 127其它)
外部仓库编号ext_warehouse_novarchar40外部仓库编号
provincevarchar50仓库设置的省份信息
cityvarchar50仓库设置的城市信息
区/县districtvarchar50仓库设置的区县信息
仓库地址addressvarchar255仓库地址
联系人contactvarchar20仓库设置中的联系人
电话telnovarchar20仓库设置中的固话信息
邮编zipVarchar255邮编
移动电话mobilevarchar40仓库设置中的手机信息
是否是残次仓is_defecttinyint1是否是残次仓(0不是,1是)
备注remarkvarchar255仓库设置中的备注信息
自定义prop1varchar100自定义1(ERP内不显示该字段)
自定义prop2varchar100自定义2(ERP内不显示该字段)
最后修改时间modifieddate
最后修改时间,格式: 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/warehouse_query.php';
    
    //$c->putApiParam('warehouse_no', 'octmami');
    $c->putApiParam('warehouse_type', '1');
    $c->putApiParam('start_time', '2016-06-20 10:00:47');
    $c->putApiParam('end_time', '2016-06-20 10:59:59');
    $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 WarehouseQuery {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        WdtClient client = new WdtClient("", "", "", "");
        Map<String, String> params = new HashMap<String, String>();
        params.put("warehouse_type", "1");
        params.put("start_time", "2018-12-01 00:00:00");
        params.put("end_time", "2018-12-11 00:00:00");

        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 WarehouseQuery
{
    class WarehouseQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/warehouse_query.php";

            client.putParams("warehouse_no", "5299");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": "0",
    "total_count": "1",
    "warehouses": [{
        "warehouse_type": "1",
        "warehouse_no": "xyp2test",
        "name": "小鹏测试仓库",
        "province": "北京",
        "city": "北京市",
        "district": "海淀区",
        "address": "花园路13号",
        "contact": "小鹏",
        "zip": "100089",
        "mobile": "13500001111",
        "telno": "010-00000000",
        "ext_warehouse_no": "xyp2test",
        "is_defect": "0",
        "remark": "测试专用仓库",
        "prop1": "",
        "prop2": "",
        "modified": "2019-05-17 14:27:14"
    }]
}

   6.2 异常响应示例

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



常用工具