# 获取库存流水
接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南
接口英文名：getstockflow
通过该接口可以获取视频号小店的商品库存流水
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/stock/getflow?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：129
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证，可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| product_id | number | 是 | 内部商品ID |
| sku_id | number | 是 | 内部sku_id |
| stock_type | number | 是 | 库存类型，枚举值参考下文 |
| finder_id | string | 否 | 达人的视频号finder_id，若StockType=1则必填 |
| begin_time | number | 是 | 时间范围开始时间戳，秒级 |
| end_time | number | 是 | 时间范围结束时间戳，秒级 |
| op_type_list | numarray | 否 | 库存事件类型，枚举值参考下文，填空获取全部 |
| page_size | number | 是 | 每页数量 |
| next_key | string | 否 | 由上次请求返回，记录翻页的上下文。传入时会从上次返回的结果往后翻一页，不传默认获取第一页数据 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| data | object | data |
# Res.data Object Payload
data
| 参数名 | 类型 | 说明 |
|---|---|---|
| stock_flow_info_list | objarray | 库存流水 |
| next_key | string | 本次翻页的上下文，用于请求下一页 |
# Res.data.stock_flow_info_list(Array) Object Payload
库存流水
| 参数名 | 类型 | 说明 |
|---|---|---|
| amount | number | 操作数量 |
| beginning_amount | number | 开始数量 |
| ending_amount | number | 结束数量 |
| stock_sub_type | number | 本次开始结束数量的库存子类型，枚举值参考下文 |
| op_type | number | 库存事件类型，枚举值参考下文 |
| update_time | number | 流水发生时间，秒级时间戳 |
| ext_info | object | 额外信息 |
# Res.data.stock_flow_info_list(Array).ext_info Object Payload
额外信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| unmove_from_stock_sub_type | number | 归还的源库存子类型，枚举值参考下文，该字段仅对仅对op_type=6生效 |
| move_to_stock_sub_type | number | 分配的目标库存子类型，枚举值参考下文，该字段仅对仅对op_type=7生效 |
| upload_source | number | 操作来源，枚举值参考下文，该字段仅对op_type=1/2/3生效 |
| order_id | number | 订单id，该字段仅对op_type=4/5生效 |
| out_warehouse_id | string | 区域仓库id，该字段仅对stock_sub_type=3生效 |
| limited_discount_id | number | 限时抢购任务id，该字段仅对stock_sub_type=2生效 |
| finder_id | string | 达人的视频号finder_id，该字段仅对move_to_stock_sub_type=4和unmove_from_stock_sub_type=4生效 |
# 4. 注意事项
- 最多可以查今天往前180天内的数据。
- 库存回滚目前只会发生在以下场景：
- 下单后支付前取消订单
- 礼物单送出后未收下退款
stock_type库存类型
| 枚举值 | 描述 |
|---|---|
| 0 | 自营库存 |
| 1 | 达人库存 |
op_type库存事件类型
| 枚举值 | 描述 |
|---|---|
| 0 | 设置库存 |
| 2 | 增加库存 |
| 3 | 减少库存 |
| 4 | 下单扣除库存 |
| 5 | 取消订单释放库存 |
| 6 | 分配库存 |
| 7 | 归还库存 |
库存子类型
| 枚举值 | 描述 |
|---|---|
| 1 | 自营通用库存 |
| 2 | 自营限时抢购库存 |
| 3 | 自营区域库存 |
| 4 | 达人专属库存 |
upload_source操作来源
| 枚举值 | 描述 |
|---|---|
| 2 | API（开发者调用） |
| 3 | API（服务商代调用） |
| 5 | 手机端 |
| 6 | web端 |
# 5. 代码示例
请求示例
{
"product_id": "10000032267694",
"sku_id": "1064839936",
"stock_type": 0,
"begin_time": 1689218360,
"end_time": 1689736760,
"page_size": 10
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"stock_flow_info_list": [{
"amount": 300,
"beginning_amount": 842,
"ending_amount": 542,
"stock_sub_type": 1,
"op_type": 6,
"update_time": 1689735682,
"ext_info": {
"move_to_stock_sub_type": 4,
"upload_source": 0,
"order_id": "0",
"out_warehouse_id": "",
"limited_discount_id": "0",
"finder_id": "sphn9rhffKDiLAf"
}
}, {
"amount": 1,
"beginning_amount": 843,
"ending_amount": 842,
"stock_sub_type": 1,
"op_type": 4,
"update_time": 1689520907,
"ext_info": {
"upload_source": 0,
"order_id": "3712984209868589056",
"out_warehouse_id": "",
"limited_discount_id": "0"
}
}],
"next_key": ""
}
}
# 6. 错误码
以下是本接口的错误码列表，其他错误码可参考 通用错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 10020052 | 商品不存在 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。