当前位置: API文档
stock_full_query.php(全量库存查询)
| 1.1 接口描述:全量获取旺店通ERP实际库存、库存占用等数据。 |
| 1.2 适用版本:网页版 |
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 举例说明: SAP、线下ERP、SRM、SCM等系统对接 |
| 环境 | HTTP地址 |
|---|---|
| 测试环境 | https://openapi.ali.huice.cc/openapi/stock_full_query.php |
| 正式环境 | https://openapi.huice.com/openapi/stock_full_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 | 否 | 按最后修改时间增量获取数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss 如不传时间按照全量查 | |
| 分页大小 | page_size | int | 否 | 每页返回条数,不传默认40 | |
| 页号 | page_no | int | 否 | 不传值默认从0页开始 | |
| 仓库id | warehouse_id | varchar | 否 | 代表仓库所有属性的唯一编码,用于仓库区 | |
| 商家编码 | spec_no | varchar | 否 | 代表单品(sku)所有属性的编码 |
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
| 错误描述 | message | varchar | 255 | 是 | 错误描述 |
| 库存数据列表 | stocks | data[] | 是 | 响应参数的1级数据节点,包含库存详细数据列表,节点下数据字段详见下述" stocks" |
stocks
| 名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
|---|---|---|---|---|---|
| 单品主键id | spec_id | bigint(20) | 是 | 单品主键id | |
仓库id | warehouse_id | int(11) | 是 | 仓库id | |
库存主键id | rec_id | bigint(20) | 是 | 库存明细主键id | |
货品编号 | goods_no | varchar | 是 | 货品编号 | |
品牌编号 | brand_no | varchar | 是 | 品牌编号 | |
品牌名称 | brand_name | varchar | 是 | 品牌名称 | |
货品名称 | goods_name | varchar | 是 | 货品名称 | |
商家编码 | spec_no | varchar | 是 | 商家编码 | |
规格名称 | spec_name | varchar | 是 | 规格名称 | |
规格码 | spec_code | varchar | 是 | 规格码 | |
条形码 | barcode | varchar | 是 | 条形码 | |
库存量 | stock_num | decimal(21, 6) | 是 | 库存量 | |
可用库存 | available_num | decimal(21, 6) | 是 | 可用库存 | |
| 单位 | unit | varchar | 是 | 单位 | |
备注 | remark | varchar | 是 | 备注 | |
成本价 | cost_price | decimal(21, 6) | 是 | 商品档案的固定成本价 | |
虚拟库存 | virtual_num | decimal(21, 6) | 是 | 虚拟库存 | |
| 是否残次品 | defect | tinyint(4) | 是 | 0否 1是 | |
| 创建时间 | created | datetime | 是 | 创建时间 | |
| 最后修改时间 | modified | datetime | 是 | 最后修改时间 | |
平均成本价 | avg_cost_price | decimal(21, 6) | 是 | 库存查询-成本价字段 |
5.请求示例
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
| JSON | {
"code": 2180,
"message": "xxxxxxxx"
} |