当前位置: API文档

shop_stock_query.php(查询店铺锁定库存)

¥标准

1.接口说明

1.1 接口描述:获取旺店通ERP的店铺锁定库存信息
1.2 适用版本:客户端 V2.5.0.3及以上版本
1.3 增量获取:按照最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。
1.4 时间跨度:start_time和end_time最大跨度为60分钟,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。
1.5注意事项:

2.调用场景

2.1 举例说明:

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境

https://sandbox.wangdian.cn/openapi2/shop_stock_query.php

正式环境https://api.wangdian.cn/openapi2/shop_stock_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 业务请求参数

名称字段类型长度
必须描述
开始时间start_timedatetime

按最后修改时间增量获取数据,start_time作为开始时间,格式: YYYY-MM-DD HH:MM:SS
结束时间end_timedatetime

按最后修改时间增量获取数据,end_time作为结束时间,格式: YYYY-MM-DD HH:MM:SS
分页大小page_sizeint

每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40使用举例单击这里
页号page_noint


不传值默认从0页开始
状态
status
int


不传获取全部,0 已释放  1 已生效

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint11只有page_no = 0 时才返回的符合条件的数据总条数,用来分页
锁定库存明细节点stock_list
data[]

响应参数的1级数据节点

   4.2 业务响应参数

    stock_list[]

名称字段类型长度
必须描述
店铺名称shop_name
varchar
255
店铺名称信息
店铺编号shop_no
varchar40

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取
仓库名称name
varchar255
仓库名称信息
仓库编号warehouse_novarchar40
代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),可通过warehouse_query.php获取
状态
status
varchar1
1 使用中,0 已失效

商家编码

spec_no
varchar40
代表单品(sku)所有属性的编码,SKU概念介绍,单击这里。传此参数,按照商家编码指定返回响应参数;若传该字段则不校验时间
主条码barcodevarchar40

获取数据时,货品档案商家编码对应的主条码
货品编号goods_no
varchar40
代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍,单击这里
规格名称spec_name
varchar255
货品档案商品规模名称信息
规格编码
spec_code
varchar40
货品档案商品规模名称信息
货品名称goods_name
varchar255
货品档案中商品信息
锁定数量original_lock_numvarchar20
生效策略中货品锁定量
未占用锁定量
lockde_num_not_occupy
varchar20
相当于“可发(可售)库存”由可审核量-“全部占用量”得出
可审核量
checkable_num
varchar20
店铺下可用库存量(包含失效策略中已占用未审核量)
未付款量locked_num_unpay
varchar20
占用锁定库存未付款货品数量
预订单量locked_num_subscribe
varchar20
占用锁定库存预订单货品数量
待审核量
locked_num_order
varchar20
占用锁定库存待审核货品数量
本次已审核量locked_num_checked
varchar20
本次生效策略中已审核货品数量
总计已审核量locked_num_checked_sum
varchar20
包含已释放和生效策略中全部已审核货品数量

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'https://sandbox.wangdian.cn/openapi2/shop_stock_query.php';
     

    $c->putApiParam('start_time', '2017-04-01 00:00:00');
    $c->putApiParam('end_time', '2017-4-12 23:59:59');
    $c->putApiParam('page_no', '0');
    $c->putApiParam('page_size', '40');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.stock;
 
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
 
import com.wangdian.api.WdtClient;
 
public class ShopStockQuery {


    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("start_time", "2018-12-01 00:00:00");
        params.put("end_time", "2018-12-11 17:00:00");
        try {
            String response = client.execute("shop_stock_query.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 ShopStockQuery
{
    class ShopStockQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "https://sandbox.wangdian.cn/openapi2/shop_stock_query.php";
 
            client.putParams("start_time", "2017-04-05 00:00:00");
            client.putParams("end_time", "2017-04-05 23:59:59");
 
            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({"start_time": '2021-01-01 00:00:00'})
params.update({"end_time": '2021-01-01 00:59:59'})
params.update({"page_size": '40'})
params.update({"page_no": '0'})

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

6.响应示例

   6.1 正常响应示例 

JSON
{
	"code":0,
	"total_count":1,
	"stock_list"[{
	         "barcode":"zd9900",
	         "checkable_num":"1.0000",
	         "goods_name":"zd9900",
	         "goods_no":"zd9900",
	         "lockde_num_not_occupy":"1.0000",
	         "locked_num_checked":"0.0000",
	         "locked_num_checked_sum":"0.0000",
	         "locked_num_order":"0.0000",
	         "locked_num_subscribe":"0.0000",
	         "locked_num_unpay":"0.0000",
	         "name":"jszc2-test2",
	         "original_lock_num":"1.0000",
	         "rec_id":"12",
	         "shop_name":"jszc2-test",
	         "shop_no":"jszc2-test",
	         "spec_code":"zd9900",
	         "spec_name":"zd9900",
	         "spec_no":"zd9900",
	         "status":"1",
	         "warehouse_no":"jszc2-test2"
	}],
	         "message":"ok"
}

   6.2 异常响应示例

JSON
{
    "code": 2180,
    "message": "start_time与end_time时间跨度不能超过最大范围"
}





常用工具