当前位置: API文档

wms.StockSpec.search(库存查询)

¥标准

1.接口说明

1.1 接口描述:获取ERP单品(sku)的库存量
1.2 适用版本:客户端 V1.4.4.7及以上版本
1.3 增量获取:支持增量获取
1.4 时间跨度:start_time和end_time最大跨度为30天

1.5 注意事项:【权限校验】:仓库权限

销量统计数据字段说明及计算方式,点击链接查看

库存量字段说明,点击链接查看


接口已过时, 请使用wms.StockSpec.search2

2.调用场景

2.1举例说明:自研商城、分销系统、全渠道等系统对接

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/openapi

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString

Y

卖家账号, 由旺店通分配
接口账号keyString
Y由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里
saltString
Y由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
Y调用的接口名称
版本号vString
Y1.0
秒级时间戳timestampint
Y秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
Y签名
分页大小page_sizeint
N分页大小,分页查询必传
分页编号page_noint
N分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
N是否计算查询结果的总条数, 需要计算则1, 否则填0       

    3.3 业务请求参数

名称字段类型长度必须描述
查询参数paramsMap<String, Object>
Y查询参数
分页pagerPager
Y

分页

params

名称字段类型长度必须描述

开始时间

start_time

String

40

N

开始时间(最后更新时间) , 传入商家编码时可传空值

结束时间

end_time

String

40

N

结束时间(最后更新时间), 传入商家编码时可传空值

商家编码

spec_nos

List<String>

40

N

商家编码列表

仓库编号

warehouse_no

String

40

N

仓库编号

掩码

mask

Int

11

N

1: 返回销量统计数据; 2: 返回成本价数据; 3:返回销售统计数据和成本价数据
不传默认为0

pager

名称字段类型长度必须描述

分页大小

page_size

Int

4

N

分页大小

页号

page_no

Int

4

N

从0开始

4.响应参数

名称字段类型长度必须描述

状态码

status

Int

11

Y

返回0为正常

数据条数

total

Int

11

N

查询结果总条数

错误信息

message

String

255

N

无错误信息不返回

单据数据

data

List<Map<String, Object>>


N

库存相关数据

data

名称字段类型长度必须描述

明细唯一键

rec_id

Int

11

Y

明细唯一键 

残次品

defect

Int

1

Y

0,正品;1,残品

库存量

stock_num

Decimal(19,4)


Y

库存量

外部库存

wms_sync_stock

Decimal(19,4)


Y

外部WMS同步时库存

库存差异

wms_stock_diff

Decimal(19,4)


Y

外部WMS同步时,与系统库存的差

商家编码

spec_no

String

40

Y

商家编码

单品id

spec_id

Int


Y

单品唯一键

货品编号

goods_no

String

40

Y

货品编号

货品名称

goods_name

String

255

Y

货品名称

规格码

spec_code

String

40

Y

规格码

品牌名称

brand_name

String

40

Y

品牌名称

规格名称

spec_name

String

100

Y

规格名称

条码

barcode

String

50

Y

条码

未付款量

unpay_num

Decimal(19,4)


Y

未付款量

预订单量

subscribe_num

Decimal(19,4)


Y

预订单量

待审核量

order_num

Decimal(19,4)


Y

待审核量

待发货量

sending_num

Decimal(19,4)


Y

待发货量

采购在途量

purchase_num

Decimal(19,4)


Y

采购在途量

调拨在途量

transfer_num

Decimal(19,4)


Y

调拨在途量

待采购量

to_purchase_num

Decimal(19,4)


Y

待采购量

采购到货量

purchase_arrive_num

Decimal(19,4)


Y

采购到货量

外部WMS同步时占用库存

wms_preempty_stock

Decimal(19,4)


Y

外部WMS同步时占用库存

重量

weight

Decimal(19,4)


Y

重量

图片URL

img_url

String

1024

Y

图片URL

仓库编号

warehouse_no

String

40

Y

仓库编号

仓库id

warehouse_id

Int

6

Y

仓库id,仓库唯一键

仓库名称

warehouse_name

String

64

Y

仓库名称

仓库类型

warehouse_type

Int

4

Y

仓库类型0为普通,非0为外部WMS

可发库存

available_send_stock

Decimal(19,4)


Y

可发库存

创建时间

created

String

40

Y

创建时间

修改时间

modified

String

40

Y

修改时间

部分付款库存

part_paid_num

Decimal(19,4)


Y

部分付款库存

销售换货在途量

refund_exch_num

Decimal(19,4)


Y

销售换货在途量(卖家发给买家)

销售退货量

refund_num

Decimal(19,4)


Y

销售退货量

销售退货在途量

refund_onway_num

Decimal(19,4)


Y

销售换货在途量(从买家回到卖家)

采购换货量

return_exch_num

Decimal(19,4)


Y

采购换货量

采购退货量

return_num

Decimal(19,4)


Y

采购退货量

采购换货在途量

return_onway_num

Decimal(19,4)


Y

采购换货在途量

待调出量

to_transfer_num

Decimal(19,4)


Y

待调出量

外部WMS同步时,占用库存差

wms_preempty_diff

Decimal(19,4)


Y

外部WMS同步时,占用库存差

与外部wms同步时间

wms_sync_time

String

40

Y

与外部wms同步时间

库存备注

remark

String

500

Y

单品在当前仓库记录的备注

锁定量

lock_num

Decimal(19,4)


Y

库存锁定量

标记id

flag_idInt

Y

标记id

标记名称
flag_name

String


Y

标记名称
品牌编号brand_noSring

Y

标记编号
其他待出库量to_other_out_num

Decimal(19,4)


Y

其他待出库量
生产待出库量to_process_out_num

Decimal(19,4)


Y

生产待出库量
生产待入库量
to_process_in_num

Decimal(19,4)


Y

生产待入库量
上次盘点时间
last_pd_time

String


Y

上次盘点时间
上次出入库时间
last_inout_time

String


Y

上次出入库时间
状态statusInt

Y

0:未启用

1:启用

2:停用

销量统计数据






今日销量

today_num

Decimal(19,4)


Y

今日销量      请求参数:mask(掩码)传为1和3时返回

7天销量

num_7days

Decimal(19,4)


Y

7天销量       请求参数:mask(掩码)传为1和3时返回

14天销量

num_14days

Decimal(19,4)


Y

14天销量     请求参数:mask(掩码)传为1和3时返回

月销量

num_month

Decimal(19,4)


Y

月销量         请求参数:mask(掩码)传为1和3时返回

总销量

num_all

Decimal(19,4)


Y

总销量         请求参数:mask(掩码)传为1和3时返回

成本价数据






成本价

cost_price

Decimal(19,4)


Y

成本价          请求参数:mask(掩码)传为2和3时返回

 5.请求示例

JSON

[{
      "start_time":   "2019-12-01 00:00:00",
      "end_time":   "2019-12-20 00:00:00",
      "spec_nos":   ["daba1"]
}]

PHP

<?php
header("Content-Type: text/html;   charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
 
$client = new   WdtErpClient("url", "wdtapi3", "appkey",   "secret");
 
$parMap = new stdClass();
$parMap->start_time = '2019-12-01   00:00:00';
$parMap->end_time = '2019-12-20   00:00:00';
$parMap->spec_nos =   ["daba1"];
 
$pager = new Pager(10, 0, true);
$data =   $client->pageCall("wms.StockSpec.search", $pager,  $parMap);
$php_json = json_encode($data,   JSON_UNESCAPED_UNICODE|JSON_PRETTY_PRINT);
echo $php_json;
?>
JAVA

C#

6.响应示

   6.1 正常响应示例 

JSON
{
    "status": 0,
    "total": 1,
    "data": [{
        "goods_no": "wangdiantong",
        "goods_name": "wangdiantong",
        "spec_code": "LL ",
        "spec_name": "暂无",
        "barcode": "wangdiantong",
        "weight": 0.2,
        "img_url": "cos:\/\/IMG135.jpg",
        "spec_no": "wangdiantong",
        "spec_id": 1,
        "brand_name": "发发拉",
        "brand_no": "ffl",
        "rec_id": 291344,
        "defect": 1,
        "status": 1,
        "stock_num": 3,
        "unpay_num": 0,
        "subscribe_num": 0,
        "order_num": 0,
        "sending_num": 0,
        "purchase_num": 0,
        "transfer_num": 0,
        "to_transfer_num": 0,
        "to_other_out_num": 0,
        "to_process_out_num": 0,
        "to_process_in_num": 0,
        "to_purchase_num": 0,
        "purchase_arrive_num": 0,
        "return_num": 0,
        "return_exch_num": 0,
        "return_onway_num": 0,
        "refund_num": 0,
        "refund_exch_num": 0,
        "refund_onway_num": 0,
        "part_paid_num": 0,
        "wms_sync_stock": 0,
        "wms_stock_diff": 0,
        "wms_preempty_stock": 0,
        "wms_preempty_diff": 0,
        "modified": "2023-04-10 14:09:55",
        "created": "2023-02-09 18:14:31",
        "warehouse_id": 624,
        "warehouse_no": "wdtapi3-test",
        "warehouse_name": "wdtapi3-test",
        "warehouse_type": 1,
        "available_send_stock": 3,
        "remark": "",
        "flag_id": 0,
        "flag_name": "无",
        "lock_num": 0,
        "last_pd_time": "2023-04-10 14:09:55",
        "last_inout_time": "2023-04-10 14:09:55",
        "today_num": 0,
        "num_7days": 0,
        "num_14days": 0,
        "num_month": 0,
        "num_all": 80,
        "cost_price": 0
    }]
}

   6.2 异常响应示例

JSON
{
       "status":   100,
       "message":   "仓库不存在 仓库编号: daba1"
}



常用工具