当前位置: API文档
stock_query_detail.php(库存明细查询)
1.1 接口描述:获取旺店通ERP库存明细数据(对应系统内"仓储-库存查询-库存明细"页面)。 |
1.2 适用版本:网页版 |
1.3增量获取:按照ERP库存记录的最后修改时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
1.4 时间跨度:start_time和end_time最大跨度为30天,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-30 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
2.调用场景
2.1 举例说明:自有商城接入ERP、金蝶接入、用友接入、SAP接入等 |
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
测试环境 | https://openapi.ali.huice.cc/openapi/stock_query_detail.php |
正式环境 | https://openapi.huice.com/openapi/stock_query_detail.php |
3.2 公共请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
卖家账号 | 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输入参数签名结果,签名算法介绍单击这里 |
3.3 业务请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
开始时间 | start_time | datetime | 是 | 按时间增量获取数据,start_time作为开始时间,格式:yyyy-MM-dd HH:mm:ss | |
结束时间 | end_time | datetime | 是 | 按时间增量获取数据,end_time作为结束时间,格式:yyyy-MM-dd HH:mm:ss | |
商家编码 | spec_no | string | 否 | 商家编码(新) | |
商家编码列表 | spec_no_list | string | 否 | 商家编码(新)批量查询,上限200个,类型是Json字符串列表,如 | |
是否残次品 | defect | tinyint | 否 | 0否 1是,需与时间查询条件一起使用 | |
仓库 | warehouse_id | int | 否 | 仓库id | |
仓库编号 | warehouse_no | string | 否 | 仓库编号,与 warehouse_id 二选一;同时传时以 warehouse_no 为准 | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~1000,不传本参数,输入值默认为100 | |
页号 | page_no | int | 否 | 页号默认从0开始 |
4.响应参数
4.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
错误码 | code | int | 40 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 10 | 否 | 符合条件的数据条数,用来分页,当 page_no = 0 时返回 |
库存明细 | stocks | data[] | 否 | 库存明细节点数据 | |
4.2 业务响应参数 | |||||
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
仓库id | warehouse_id | int | 是 | 仓库id | |
仓库编号 | warehouse_no | string | 是 | 仓库编号 | |
仓库名称 | warehouse_name | string | 是 | 仓库名称 | |
货品编码 | goods_no | string | 是 | 货品编码 | |
货品类型 | goods_type | int | 是 | 货品类型 1成品、2半成品、3原料、4包装材料、5辅料、6资产。默认值为:成品 | |
货品名称 | goods_name | string | 是 | 货品名称 | |
货品简称 | goods_short_name | string | 是 | 货品简称 | |
货品分类 | goods_category | string | 是 | 货品分类 | |
商家编码 | spec_no | string | 是 | 商家编码 | |
规格辅助码 | spec_code | string | 是 | 规格辅助码 | |
规格名称 | spec_name | string | 是 | 规格名称 | |
主条码 | barcode | string | 是 | 主条码 | |
商品标签 | goods_label | string | 是 | 商品标签 | |
品牌 | brand_name | string | 是 | 品牌 | |
规格备注 | spec_remark | string | 是 | 规格备注 | |
箱规 | box_spec | string | 是 | 箱规 | |
颜色 | color | string | 是 | 箱规 | |
尺码 | size | string | 是 | 尺码 | |
货区类型 | zone_type | int | 否 | 开启货位库存后会存在货区类型 | |
货区名称 | zone_name | string | 否 | 开启货位库存后会存在货区名称 | |
货位 | position_no | string | 否 | 开启货位库存后会存在货位信息 | |
批次 | batch_no | string | 否 | 开启批次管理后会存在批次信息 | |
库存数量 | stock_num | decimal(21,6) | 是 | 库存数量 | |
库存占用量 | reserve_num | decimal(21,6) | 是 | 库存占用量 | |
库存可用量 | available_num | decimal(21,6) | 是 | 库存可用量 | |
成本价 | cost_price | decimal(21,6) | 是 | 成本价 | |
库存属性 | defect | tinyint(4) | 是 | 0-正品 1-次品 | |
生产日期 | production_date | date | 否 | 开启有效期管理后会存在生产日期 | |
保质期(天) | validity_days | int | 否 | 开启有效期管理后会存在保质期 | |
有效期 | expire_date | date | 否 | 开启有效期管理后会存在有效期 | |
距离到期天数 | distance_to_expiry_days | int | 否 | 开启有效期管理后会存在到期天数 | |
距离临期天数 | distance_to_near_expiry_days | int | 否 | 开启有效期管理后会存在临期天数 | |
剩余有效期比例 | residual_validity_proportion | string | 否 | 开启有效期管理后会存在有效期比例 | |
6.响应示例
5.1 正常响应示例
| JSON | {
"code": 0,
"message": "",
"total_count": 1,
"stocks": [{
"warehouse_id": "429",
"warehouse_name": "广州白云",
"warehouse_no": "429",
"goods_no": "8141189",
"goods_type": 1,
"goods_name": "dpa帝比爱金牌海豹油软胶囊(180粒\/瓶)",
"goods_short_name": "",
"goods_category": null,
"spec_no": "8141189",
"spec_code": "8141189",
"spec_name": "",
"barcode": "260709701",
"goods_label": null,
"brand_name": null,
"spec_remark": "",
"box_spec": "-",
"color": "",
"size": "",
"zone_type": null,
"zone_name": null,
"position_no": null,
"batch_no": "0912982941",
"stock_num": "297",
"reserve_num": "3",
"available_num": "294",
"cost_price": "0",
"defect": 0,
"production_date": "2025-12-09",
"validity_days": 1000,
"expire_date": "2028-09-04",
"distance_to_expiry_days": 741,
"distance_to_near_expiry_days": 741,
"residual_validity_proportion": "74.10%"
}]
} |
5.2 异常响应示例
| JSON | {
"code": 2900,
"message": "时间范围不能为空"
} |