# 获取库存
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getstock
通过该接口可以获取微信小店的商品库存信息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/product/stock/get?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.product.stock.get
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:129
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 示例 | 说明 |
---|---|---|---|---|
product_id | string | 是 | 10000000088178 | 内部商品ID |
sku_id | string | 是 | 462966239 | 内部sku_id |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
data | object | data |
# Res.data Object Payload
data
参数名 | 类型 | 说明 |
---|---|---|
normal_stock_num | number | 通用库存数量 |
limited_discount_stock_num | number | 限时抢购库存数量 |
warehouse_stocks | objarray | 区域库存 |
total_stock_num | number | 库存总量:通用库存数量 + 限时抢购库存数量 + 区域库存总量 |
# Res.data.warehouse_stocks(Array) Object Payload
区域库存
参数名 | 类型 | 说明 |
---|---|---|
out_warehouse_id | string | 区域库存外部id |
num | number | 区域库存数量 |
lock_stock | number | 区域库存的锁定库存(已下单未支付的库存)数量 |
# 4. 注意事项
- 库存回滚目前只会发生在以下场景:
- 下单后支付前取消订单
- 礼物单送出后未收下退款
# 5. 代码示例
请求示例
{
"product_id": "10000000088178",
"sku_id": "462966239"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"data": {
"normal_stock_num": 998,
"limited_discount_stock_num": 0,
"warehouse_stocks": [{
"out_warehouse_id": "test1",
"num": 10
}, {
"out_warehouse_id": "test2",
"num": 22
}, {
"out_warehouse_id": "test3",
"num": 33
}, {
"out_warehouse_id": "test4",
"num": 44
}],
"total_stock_num": 1107
}
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
10020052 | 商品不存在 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。