当前位置: API文档
shop_stock_query.php(查询店铺锁定库存)
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.1 举例说明: |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/shop_stock_query.php |
正式环境 | https://api.wangdian.cn/openapi2/shop_stock_query.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输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | datetime | 是 | 按最后修改时间增量获取数据,start_time作为开始时间,格式: YYYY-MM-DD HH:MM:SS | |
结束时间 | end_time | datetime | 是 | 按最后修改时间增量获取数据,end_time作为结束时间,格式: YYYY-MM-DD HH:MM:SS | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40使用举例单击这里 | |
页号 | page_no | int | 否 | 不传值默认从0页开始 | |
状态 | status | int | 否 | 不传获取全部,0 已释放 1 已生效 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 11 | 否 | 只有page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
锁定库存明细节点 | stock_list | data[] | 是 | 响应参数的1级数据节点 |
stock_list[]
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺名称 | shop_name | varchar | 255 | 是 | 店铺名称信息 |
店铺编号 | shop_no | varchar | 40 | 是 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取 |
仓库名称 | name | varchar | 255 | 是 | 仓库名称信息 |
仓库编号 | warehouse_no | varchar | 40 | 是 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),可通过warehouse_query.php获取 |
状态 | status | varchar | 1 | 是 | 1 使用中,0 已失效 |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(sku)所有属性的编码,SKU概念介绍,单击这里。传此参数,按照商家编码指定返回响应参数;若传该字段则不校验时间 |
主条码 | barcode | varchar | 40 | 是 | 获取数据时,货品档案商家编码对应的主条码 |
货品编号 | goods_no | varchar | 40 | 是 | 代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍,单击这里 |
规格名称 | spec_name | varchar | 255 | 是 | 货品档案商品规模名称信息 |
规格编码 | spec_code | varchar | 40 | 是 | 货品档案商品规模名称信息 |
货品名称 | goods_name | varchar | 255 | 是 | 货品档案中商品信息 |
锁定数量 | original_lock_num | varchar | 20 | 是 | 生效策略中货品锁定量 |
未占用锁定量 | lockde_num_not_occupy | varchar | 20 | 是 | 相当于“可发(可售)库存”由可审核量-“全部占用量”得出 |
可审核量 | checkable_num | varchar | 20 | 是 | 店铺下可用库存量(包含失效策略中已占用未审核量) |
未付款量 | locked_num_unpay | varchar | 20 | 是 | 占用锁定库存未付款货品数量 |
预订单量 | locked_num_subscribe | varchar | 20 | 是 | 占用锁定库存预订单货品数量 |
待审核量 | locked_num_order | varchar | 20 | 是 | 占用锁定库存待审核货品数量 |
本次已审核量 | locked_num_checked | varchar | 20 | 是 | 本次生效策略中已审核货品数量 |
总计已审核量 | locked_num_checked_sum | varchar | 20 | 是 | 包含已释放和生效策略中全部已审核货品数量 |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 2180, "message": "start_time与end_time时间跨度不能超过最大范围" } |