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/skuInventory

指定商品分仓库存#

提供精准的SKU库存查询能力,支持按发货区域和仓库ID筛选库存信息,返回结果包含商品基本信息及各区域的库存分布。

适用场景#

按SKU查询商品在指定区域或仓库的库存
获取商品的基本信息(名称、图片、型号等)及库存详情
批量查询多个SKU的库存分布情况

接口类型#

POST

请求频率限制#

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

请求说明#

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

请求参数#

Header参数#

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

Body参数#

根 字段
参数名类型必填默认值可选值说明
skusarray是--SKU列表,最多不超过20个
depot_idsarray否--仓库ID列表,用于筛选指定仓库的库存
region_codesarray否-标准国家二字码发货国家二字码列表,用于筛选指定区域的库存

响应字段说明#

成功响应(HTTP 200)
根 字段
字段类型说明
codeinteger业务状态码(0表示成功)
msgstring提示信息(成功时为空)
dataobject业务数据,以SKU为键的对象
data对象 字段(以SKU为键)
字段类型说明
idintegerSKU的唯一ID
skustringSKU编码
modelstring商品型号
product_idinteger关联的产品ID
namestring商品名称
inventoriesarray库存列表(按发货优先级排序)
product_imagestring产品主图URL
sku_imagestringSKU对应的图片URL
inventories数组 字段
字段类型说明
delivery_region_idinteger发货区域ID
delivery_region_namestring发货区域名称(如:美国)
depot_namestring仓库名称
depot_idinteger仓库ID
depot_sortstring仓库排序(按发货优先级)
qtystring库存数量

调用示例#

URL请求#

请求示例#

{
    "skus": [
        "cbsft114yy02-一盒12pcs",
        "bns214yx01-40ml",
        "aijy114yx01-10ml"
    ],
    "depot_ids": [],
    "region_codes": [
        "TG",
        "US"
    ]
}

成功返回示例#

{
    "code": 0,
    "msg": "",
    "data": {
        "aijy114yx01-10ml": {
            "id": 1137,
            "sku": "aijy114yx01-10ml",
            "model": "10ml",
            "product_id": 99,
            "name": "South Moon 艾草精油 身体按摩缓解疼痛疲劳塑形精油",
            "inventories": [
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "美国1仓",
                    "depot_id": 3,
                    "depot_sort": "1",
                    "qty": "0"
                },
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "美国2仓",
                    "depot_id": 11,
                    "depot_sort": "2",
                    "qty": "0"
                }
            ],
            "product_image": "https://oss.westmonth.com/westmonth/SKUDatum/old/aijy114yx01-10ml/mainpicture/aijy114yx01-10ml-002.jpg",
            "sku_image": "https://oss.westmonth.com/westmonth/SKUDatum/aijy114yx01/mainpicture/aijy114yx01-2002.jpg"
        },
        "bns214yx01-40ml": {
            "id": 1135,
            "sku": "bns214yx01-40ml",
            "model": "40ml",
            "product_id": 96,
            "name": "Jaysuing 玻尿酸护手精华 玻尿酸抗衰老护肤保湿精华液",
            "inventories": [
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "美国1仓",
                    "depot_id": 3,
                    "depot_sort": "1",
                    "qty": "0"
                },
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "美国2仓",
                    "depot_id": 11,
                    "depot_sort": "2",
                    "qty": "0"
                }
            ],
            "product_image": "https://oss.westmonth.com/westmonth/SKUDatum/old/bns214yx01-40ml/mainpicture/bns214yx01-40ml-001.jpg",
            "sku_image": "https://oss.westmonth.com/westmonth/SKUDatum/bns214yx01-40ml/mainpicture/bns214yx01-40ml-27691196.png"
        },
        "cbsft114yy02-一盒12pcs": {
            "id": 513,
            "sku": "cbsft114yy02-一盒12pcs",
            "model": "12pcs",
            "product_id": 100,
            "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
            "inventories": [
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "美国1仓",
                    "depot_id": 3,
                    "depot_sort": "1",
                    "qty": "0"
                },
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "美国2仓",
                    "depot_id": 11,
                    "depot_sort": "2",
                    "qty": "0"
                }
            ],
            "product_image": "https://oss.westmonth.com/westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
            "sku_image": "https://oss.westmonth.com/westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg"
        }
    }
}

失败返回示例#

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

错误处理#

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

注意事项#

skus参数为必填项,且最多支持20个SKU,超过数量会返回参数错误
region_codes参数需传入标准国家二字码(如:US代表美国,TG代表多哥)
库存列表(inventories)按仓库发货优先级排序,可直接用于判断发货顺序
若未传入depot_ids和region_codes参数,将返回该SKU在所有区域和仓库的库存信息

常见问题#

Q1:如何筛选美国区域的库存?#

A:在region_codes参数中传入["US"],即可查询SKU在美国区域的库存信息。

Q2:返回结果中data的键是什么?#

A:data的键为传入的SKU编码,如查询["cbsft114yy02-一盒12pcs", "bns214yx01-40ml"],则data的键为这两个SKU。

Q3:inventories中的仓库排序依据是什么?#

A:按仓库的发货优先级排序,优先级高的仓库排在前面,可作为发货选择的参考。

Q4:如何获取商品的图片信息?#

A:通过返回结果中的product_image(产品主图)和sku_image(SKU图片)字段获取图片URL。

版本历史#

版本日期修改说明
v1.02025-04-01初始版本,支持按SKU、区域、仓库查询库存

请求参数

Header 参数

Body 参数application/json

示例
{
	"skus": [
		"cbsft114yy02-一盒12pcs",
		"bns214yx01-40ml",
		"aijy114yx01-10ml"
	],
	"depot_ids": [],
	"region_codes": [
		"TG",
		"US"
	]
}

请求示例代码

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/skuInventory' \
--header 'Authorization: {{token}}' \
--header 'Cookie: {{cookie}};{{cookie}}' \
--header 'Content-Type: application/json' \
--data '{
	"skus": [
		"cbsft114yy02-一盒12pcs",
		"bns214yx01-40ml",
		"aijy114yx01-10ml"
	],
	"depot_ids": [],
	"region_codes": [
		"TG",
		"US"
	]
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "code": 0,
    "msg": "",
    "data": {
        "aijy114yx01-10ml": {
            "id": 1137,
            "sku": "aijy114yx01-10ml",
            "model": "10ml",
            "product_id": 99,
            "name": "South Moon 艾草精油 身体按摩缓解疼痛疲劳塑形精油",
            "inventories": [
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "",
                    "depot_id": 0,
                    "depot_sort": "0",
                    "qty": "0"
                }
            ],
            "product_image": "https://westmonth/SKUDatum/old/aijy114yx01-10ml/mainpicture/aijy114yx01-10ml-002.jpg",
            "sku_image": "https://westmonth/SKUDatum/aijy114yx01/mainpicture/aijy114yx01-2002.jpg"
        },
        "bns214yx01-40ml": {
            "id": 1135,
            "sku": "bns214yx01-40ml",
            "model": "40ml",
            "product_id": 96,
            "name": "Jaysuing 玻尿酸护手精华 玻尿酸抗衰老护肤保湿精华液",
            "inventories": [
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "",
                    "depot_id": 0,
                    "depot_sort": "0",
                    "qty": "0"
                }
            ],
            "product_image": "https://westmonth/SKUDatum/old/bns214yx01-40ml/mainpicture/bns214yx01-40ml-001.jpg",
            "sku_image": ""
        },
        "cbsft114yy02-一盒12pcs": {
            "id": 513,
            "sku": "cbsft114yy02-一盒12pcs",
            "model": "12pcs",
            "product_id": 100,
            "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
            "inventories": [
                {
                    "delivery_region_id": 3,
                    "delivery_region_name": "美国",
                    "depot_name": "",
                    "depot_id": 0,
                    "depot_sort": "0",
                    "qty": "0"
                }
            ],
            "product_image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
            "sku_image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg"
        }
    }
}
修改于 2026-02-24 03:17:13
上一页
商品分仓库存列表
下一页
圈货、备货库存查询
Built with