当前位置: API文档
stock_query_all.php(全量查询库存)
1.1 接口描述:全量获取ERP实际库存、库存占用等数据。 |
1.2 适用版本:客户端 V2.4.0.5及以上版本 |
1.3 增量获取:按照最库存管理数据最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
1.5注意事项: ①只允许凌晨00:00-02:00调用,其余时间调用会报错。 ②接口返回的“库存量”字段值是仓库中的实物库存量,“可发库存量”可理解为可销售库存量或未被占用库存量,可发库存计算方式,需要对照系统设置中的可发库存计算公式 |
2.1 线下ERP、自研商城等系统对接 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/stock_query_all.php |
正式环境 | https://api.wangdian.cn/openapi2/stock_query_all.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输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
仓库编号 | warehouse_no | varchar | 否 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置),传此参数不传开始和结束时间,默认时间区间从请求时间前推一小时返回数据; 传此参数并且传开始和结束时间,按照传参的时间区间返回数据;(不支持一次推送多个仓库编号) 不传此参数则返回ERP所有仓库中符合传参条件的数据 | |
商家编码 | spec_no | varchar | 否 | 代表单品(sku)所有属性的编码,SKU概念介绍,单击这里。传此参数,按照商家编码指定返回响应参数;若传该字段则不校验时间 | |
条码 | barcode | varchar | 否 | 传此参数,按照条码指定返回响应参数,若传该字段则不校验时间 | |
开始时间 | start_time | date | 是 | 按最后修改时间增量获取数据,start_time作为开始时间,格式:YYYY-MM-DD HH:MM:SS | |
结束时间 | end_time | date | 是 | 按最后修改时间增量获取数据,end_time作为结束时间,格式:YYYY-MM-DD HH:MM:SS | |
分页大小 | page_size | int | 否 | 每页返回数据条数,输入值范围1~100,不传本参数,输入值默认为40,使用举例单击这里 | |
页号 | page_no | int | 否 | 不传值默认从0页开始 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 10 | 否 | 只有,page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
库存信息列表 | stocks[ ] | data | 是 | 响应参数的级数据节点,包含当前页的库存管理信息的数据节点,节点下数据字段详见下述“stocks”列表 |
stocks
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
单品主键id | spec_id | int | 11 | 是 | 单品主键id |
货品编号 | goods_no | varchar | 40 | 是 | 代表SPU所有属性的唯一编号,用于系统货品的区分,SPU概念介绍,单击这里 |
品牌编号 | brand_no | varchar | 32 | 是 | 品牌编号 |
品牌名称 | brand_name | varchar | 64 | 是 | 品牌名称,ERP版本V2.3.8.4及以上才可返回 |
货品名称 | goods_name | varchar | 255 | 是 | 货品名称 |
商家编码 | spec_no | varchar | 40 | 是 | 代表单品(SKU)所有属性的唯一编号,用于系统单品的区分,SKU概念介绍,单击这里 |
规格名称 | spec_name | varchar | 100 | 是 | 规格名称 |
规格码 | spec_code | varchar | 40 | 是 | 规格码 |
条形码 | barcode | varchar | 50 | 是 | 条形码 |
仓库主键id | warehouse_id | int | 11 | 是 | 仓库主键id |
仓库编号 | warehouse_no | varchar | 40 | 是 | 代表仓库所有属性的唯一编码,用于仓库区分,ERP内支持自定义(ERP仓库界面设置) |
仓库名称 | warehouse_name | varchar | 64 | 是 | 仓库名称 |
仓库类型 | warehouse_type | tinyint | 4 | 是 | 仓库类型0为普通,非0为外部WMS |
库存量 | stock_num | decimal | (19,4) | 是 | 库存量 |
锁定量 | lock_num | decimal | (19,4) | 是 | 锁定量 |
未付款量 | unpay_num | decimal | (19,4) | 是 | 未付款量 |
预订单量 | subscribe_num | decimal | (19,4) | 是 | 预订单量 |
待审核量 | order_num | decimal | (19,4) | 是 | 待审核量 |
待发货量 | sending_num | decimal | (19,4) | 是 | 待发货量 |
采在途量 | purchase_num | decimal | (19,4) | 是 | 采在途量 |
调拨在途量 | transfer_num | decimal | (19,4) | 是 | 调拨在途量 |
待调拨量 | to_transfer_num | decimal | (19,4) | 是 | 待调拨量 |
待采购量 | to_purchase_num | decimal | (19,4) | 是 | 待采购量 |
采购到货量 | purchase_arrive_num | decimal | (19,4) | 是 | 采购到货量 |
采购退货量 | return_num | decimal | (19,4) | 是 | 采购退货量 |
采购换货量 | return_exch_num | decimal | (19,4) | 是 | 采购换货量 |
采购换货在途量 | return_onway_num | decimal | (19,4) | 是 | 采购换货在途量 |
销售退货量 | refund_num | decimal | (19,4) | 是 | 销售退货量 |
生产在途量 | process_onway_num | decimal | (19,4) | 是 | 生产在途量 |
销售退货在途量 | refund_onway_num | decimal | (19,4) | 是 | 销售退货在途量 |
部分付款库存 | part_paid_num | decimal | (19,4) | 是 | 部分付款库存 |
负库存出库量 | neg_stockout_num | decimal) | (19,4) | 是 | 负库存出库量 |
今日销量 | today_num | decimal | (19,4) | 是 | 今日销量 |
警戒库存 | safe_stock | decimal | (19,4) | 是 | 警戒库存 |
外部WMS中的编码 | spec_wh_no | varchar | 40 | 是 | 单品在外部WMS中的编码,如在物流宝仓库中主键 |
外部WMS同步时库存 | wms_sync_stock | decimal | (19,4) | 是 | 外部WMS同步时库存 |
外部WMS同步时占用库存 | wms_preempty_stock | decimal | (19,4) | 是 | 外部WMS同步时占用库存 |
外部WMS同步时,与系统库存的差 | wms_stock_diff | decimal | (19,4) | 是 | 外部WMS同步时,与系统库存的差 |
与外部WMS同步时间 | wms_sync_time | datetime | datetime | 是 | 与外部WMS同步时间wms_sync_stock-stock_num |
成本价 | cost_price | decimal | (13,4) | 是 | 成本价 |
重量 | weight | decimal | (19,4) | 是 | 重量 |
商品图片url | img_url | varchar | 1024 | 是 | 商品图片url |
最后修改时间 | modified | datetime | datetime | 是 | 最后修改时间,格式:YYYY-MM-DD HH:MM:SS |