1. 库存
西之月开放接口(openapi)
  • 西之月开放平台介绍
  • 西之月接入流程
  • 西之月开放API
  • 西之月订阅通知
  • 公共错误码
  • 货盘页面接入说明
  • openapi
    • 商品
      • 📖商品能力
      • SKU
        • SKU列表
        • SKU信息
        • SKU信息及价格
        • SKU查询客户价格
        • SKU查询英代欧代美代协议
        • SKU一体化标签
        • SKU一体化标签平台
        • SKU证书
        • SKU六面图
        • SKU商品图包
        • SKU视频
        • SKU商品标签【国内】
        • SKU产品文案
        • SKU实拍图附带一体化标签
        • SKU图包资料
      • 库存
        • 商品总库存列表
          POST
        • 商品分仓库存列表
          POST
        • 指定商品分仓库存
          POST
        • 圈货、备货库存查询
          POST
        • SKU实时库存【国内】
          POST
      • 商品列表
        GET
      • 商品详情
        GET
      • 商品价格
        POST
      • 个性化商品价格列表
        POST
      • 商品所有档位价格
        POST
      • 商品分类
        GET
      • 商品分类-获取子分类
        GET
      • 商品品牌
        GET
      • 商品证书
        GET
      • 商品使用说明书
        GET
    • 订单
      • 📖订单能力
      • 交接单
        • 交接单列表
        • 验证订单允许上传交接单
        • 上传交接单文件
        • 保存交接单
      • 创建订单
      • 订单预计算
      • 订单列表
      • 订单详情
      • 订单详情列表
      • 订单取消
      • 订单状态
      • 订单支付状态
      • 订单物流轨迹
    • 支付
      • 📖支付能力
      • 订单支付页面
      • 发起支付
      • 获取支付方式
      • 获取订单支付信息
    • 售后
      • 📖售后能力
      • 获取发起售后配置数据
      • 订单发起售后
      • 撤销售后
    • 账期
      • 📖账期能力
      • 已结清账期-账单列表
      • 未结清账期-账单列表
      • 未结清账单-销售订单列表
      • 未结清账单-售后订单列表
    • 品牌授权
      • 📖品牌授权能力
      • 获取授权平台列表
      • 获取模板类型列表
      • 获取授权品牌列表
      • 获取执照列表信息
      • 品牌授权申请
      • 品牌授权记录
      • 品牌授权作废
    • 其他
      • 📖其它能力
      • 仓库
        • 仓库列表信息
        • 发货区域列表
      • 物流
        • 物流公司列表
        • 获取运费接口
      • 平台
        • 获取授权码
        • 平台列表信息-新
        • 平台列表信息
      • 用户
        • 根据token获取用户信息
    • 订阅通知
      • 商品信息变更
      • 商品上下架状态变更
      • 商品库存变更
      • 商品价格变更
      • 商品删除
  1. 库存

商品分仓库存列表

外部-测试环境
https://testing.westmonth.com
外部-测试环境
https://testing.westmonth.com
POST
/openapi/v2/inventory/query

商品分仓库存列表#

提供更精准的商品库存查询能力,支持查询SKU在各仓库下的具体库存数量,相比V1版本增加了仓库维度的库存信息。

适用场景#

精确查询商品在各仓库的库存分布
按区域和仓库筛选商品库存
批量查询多个SKU的库存详情(含区域和仓库信息)

接口类型#

POST

请求频率限制#

默认频率:以平台配额为准

请求说明#

请求URL
正式环境:https://www.westmonth.com/openapi/v2/inventory/query
测试环境:https://testing.westmonth.com/openapi/v2/inventory/query

请求参数#

Header参数#

参数名类型必填示例值说明
Authorizationstring是authorization身份验证Token
Content-Typestring是application/json建议固定传此值

Body参数#

根 字段
参数名类型必填默认值可选值说明
depot_idsarray否--仓库ID列表,最多不超过50个
skusarray否--SKU列表,最多不超过20个,传此参数时不做分页
pageinteger否1-页码,不填默认1
sizeinteger否50最大100每页显示数量,默认50,最大100

响应字段说明#

成功响应(HTTP 200)
根 字段
字段类型说明
codeinteger业务状态码(0表示成功)
msgstring提示信息(成功时为空)
dataobject业务数据
data对象 字段
字段类型说明
pageinteger当前页码
sizeinteger每页展示数量
data_countinteger总数据量
page_countinteger总页数
has_nextboolean是否有下一页(true:有,false:无)
listarray库存信息列表
list数组 字段
字段类型说明
skustringSKU编码
namestringSKU商品名称
region_listarray区域列表(按发货区域划分)
region_list数组 字段
字段类型说明
region_namestring区域名称(如:泰国、中国)
delivery_region_idinteger发货区域ID
pricestring商品价格
depotsarray仓库列表(该区域下的仓库)
depots数组 字段
字段类型说明
quantityinteger该仓库下的商品库存数量
depot_idinteger仓库ID
depot_namestring仓库名称(如:泰国1仓、中国仓)

调用示例#

URL请求#

请求示例#

{
    "skus": [
        "EEA02-A142-4-YE1",
        "EEA02-A143-20-VT1",
        "EEA02-A144-30-WH1"
    ],
    "page": 1,
    "size": 50,
    "depot_ids": [
        2,
        5
    ]
}

成功返回示例#

{
    "code": 0,
    "msg": "",
    "data": {
        "page": 0,
        "size": 0,
        "data_count": 3,
        "page_count": 0,
        "has_next": false,
        "list": [
            {
                "sku": "EEA02-A144-30-WH1",
                "name": "EELHOE 抗皱面部精华 淡斑补水抗皱防衰老精华",
                "region_list": [
                    {
                        "region_name": "泰国",
                        "delivery_region_id": 2,
                        "price": "10.50",
                        "depots": [
                            {
                                "quantity": 271,
                                "depot_id": 2,
                                "depot_name": "泰国1仓"
                            }
                        ]
                    },
                    {
                        "region_name": "中国",
                        "delivery_region_id": 5,
                        "price": 0,
                        "depots": [
                            {
                                "quantity": 0,
                                "depot_id": 5,
                                "depot_name": "中国仓"
                            }
                        ]
                    }
                ]
            },
            {
                "sku": "EEA02-A143-20-VT1",
                "name": "EELHOE 烟酰胺精华 护肤提拉淡斑抗皱精华",
                "region_list": [
                    {
                        "region_name": "泰国",
                        "delivery_region_id": 2,
                        "price": "7.50",
                        "depots": [
                            {
                                "quantity": 277,
                                "depot_id": 2,
                                "depot_name": "泰国1仓"
                            }
                        ]
                    }
                ]
            },
            {
                "sku": "EEA02-A142-4-YE1",
                "name": "EELHOE 维生素C眼霜棒 黑眼圈修护滋润紧致眼霜棒",
                "region_list": [
                    {
                        "region_name": "泰国",
                        "delivery_region_id": 2,
                        "price": "10.50",
                        "depots": [
                            {
                                "quantity": 889,
                                "depot_id": 2,
                                "depot_name": "泰国1仓"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

失败返回示例#

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理#

公共错误码
HTTP status code错误码错误信息描述

注意事项#

当传入skus参数时,接口不进行分页,直接返回所有查询的SKU结果
若需分页查询,请勿传入skus参数,通过page和size控制分页
仓库ID可通过/openapi/depot/list接口获取
发货区域ID可通过/openapi/productCategory/getDeliveryRegions接口获取

常见问题#

Q1:如何查询指定仓库的库存?#

A:通过depot_ids参数传入目标仓库ID列表,如[2,5],即可查询这些仓库的库存信息。

Q2:传入skus参数后,分页参数page和size是否生效?#

A:不生效。当传入skus参数时,接口会返回所有查询的SKU结果,不进行分页。

Q3:region_list和depots的关系是什么?#

A:region_list表示按发货区域划分的分组,每个区域下包含该区域内的仓库列表(depots),即一个区域可能包含多个仓库。

Q4:如何获取仓库ID和发货区域ID?#

A:仓库ID可通过/openapi/depot/list接口获取,发货区域ID可通过/openapi/productCategory/getDeliveryRegions接口获取。

版本历史#

版本日期修改说明
v2.02025-03-15新增版本,支持仓库维度库存查询
v1.02025-01-01初始版本,仅支持总库存查询

请求参数

Header 参数

Body 参数application/json

示例
{
    "skus": [
        "EEA02-A142-4-YE1",
        "EEA02-A143-20-VT1",
        "EEA02-A144-30-WH1"
    ],
    "page": 1,
    "size": 50,
    "depot_ids": [
        2,
        5
    ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://testing.westmonth.com/openapi/v2/inventory/query' \
--header 'Authorization: {{token}}' \
--header 'Cookie: {{cookie}};{{cookie}}' \
--header 'Content-Type: application/json' \
--data '{
    "skus": [
        "EEA02-A142-4-YE1",
        "EEA02-A143-20-VT1",
        "EEA02-A144-30-WH1"
    ],
    "page": 1,
    "size": 50,
    "depot_ids": [
        2,
        5
    ]
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "code": 0,
    "msg": "",
    "data": {
        "page": 0,
        "size": 0,
        "data_count": 3,
        "page_count": 0,
        "has_next": false,
        "list": [
            {
                "sku": "EEA02-A142-4-YE1",
                "name": "EELHOE 维生素C眼霜棒 黑眼圈修护滋润紧致眼霜棒",
                "region_list": [
                    {
                        "region_name": "泰国",
                        "delivery_region_id": 2,
                        "price": "8.50",
                        "depots": [
                            {
                                "quantity": 969,
                                "depot_id": 2,
                                "depot_name": "泰国1仓"
                            }
                        ]
                    }
                ]
            },
            {
                "sku": "EEA02-A143-20-VT1",
                "name": "EELHOE 烟酰胺精华 护肤提拉淡斑抗皱精华",
                "region_list": [
                    {
                        "region_name": "泰国",
                        "delivery_region_id": 2,
                        "price": "8.50",
                        "depots": [
                            {
                                "quantity": 301,
                                "depot_id": 2,
                                "depot_name": "泰国1仓"
                            }
                        ]
                    }
                ]
            },
            {
                "sku": "EEA02-A144-30-WH1",
                "name": "EELHOE 抗皱面部精华 淡斑补水抗皱防衰老精华",
                "region_list": [
                    {
                        "region_name": "泰国",
                        "delivery_region_id": 2,
                        "price": "8.50",
                        "depots": [
                            {
                                "quantity": 278,
                                "depot_id": 2,
                                "depot_name": "泰国1仓"
                            }
                        ]
                    },
                    {
                        "region_name": "中国",
                        "delivery_region_id": 5,
                        "price": "8.00",
                        "depots": [
                            {
                                "quantity": 0,
                                "depot_id": 5,
                                "depot_name": "中国仓"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
修改于 2026-02-24 03:17:07
上一页
商品总库存列表
下一页
指定商品分仓库存
Built with