商品列表
外部-测试环境
https://testing.westmonth.com
外部-测试环境
https://testing.westmonth.com
GET
/openapi/product/list
商品列表接口
适用场景
接口类型
请求频率限制
请求说明
https://www.westmonth.com/openapi/product/list测试环境：
https://testing.westmonth.com/openapi/product/list请求参数
Header参数
| 参数名 | 类型 | 必填 | 示例值 | 说明 |
|---|---|---|---|---|
| Authorization | string | 是 | authorization | 身份验证Token |
| Content-Type | string | 否 | application/json | 可选，建议传此值 |
Query参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| page | integer | 否 | 1 | 当前页码 |
| size | integer | 否 | 20 | 每页记录数（最大50） |
| delivery_region_id | integer | 否 | - | 发货区ID（指定单个发货区域） |
| delivery_region_ids | string | 否 | - | 发货区IDs（多个用逗号连接，如“1,2,3”） |
| category_id | integer | 否 | - | 分类ID（筛选特定分类下的商品） |
| brand_id | string | 否 | - | 品牌ID |
| locale | string | 否 | zh_cn | 语言（zh_cn=中文，en=英文） |
| platform_id | string | 否 | - | 平台ID（关联特定平台的商品） |
| newtime | integer | 否 | - | 上新时间（整数，如5表示5天内上新） |
| newtime_start_time | string | 否 | - | 上新开始时间（格式：YYYY-MM-DD HH:MM:SS） |
| newtime_end_time | string | 否 | - | 上新结束时间（格式：YYYY-MM-DD HH:MM:SS） |
| low_price | string | 否 | - | 价格范围起始值 |
| high_price | string | 否 | - | 价格范围结束值 |
| keyword | string | 否 | - | 关键字查询（匹配商品名称） |
| sort_field | integer | 否 | 1 | 排序字段（1=价格，2=销量，3=创建时间，4=库存） |
| sort_mode | integer | 否 | 1 | 排序方式（1=升序，2=降序） |
| certificate_assort_id | integer | 否 | - | 证书分类ID（通过“获取所有证书”接口获取） |
| onlyShow | integer | 否 | 0 | 仅看有货（1=是，0=否） |
| product_sku_ids | array | 否 | - | 商品SKU ID列表（精确查询指定SKU的商品） |
响应字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| code | integer | 业务状态码（0表示成功） |
| msg | string | 提示信息（成功时为空） |
| data | object | 商品列表数据 |
| 字段 | 类型 | 说明 |
|---|---|---|
| total | integer | 符合条件的商品总数 |
| page | string | 当前页码 |
| list | array | 商品列表（当前页数据） |
| 字段 | 类型 | 说明 |
|---|---|---|
| product_sku_id | integer | SKU唯一标识ID |
| product_id | integer | 商品ID |
| product_sku | string | 商品SKU编码 |
| delivery_region_id | string | 发货区域id |
| product_sku_is_default | string | 是否默认SKU（0：否；1：是 |
| product_sku_hs_code | string | 海关编码 |
| customer_wishlist_id | string | 客户收藏夹ID |
| product_name | string | 商品名称（支持多语言，由locale参数控制） |
| product_name_en | string | 商品名称（英文） |
| product_price | string | 商品价格（带货币符号） |
| stock_status | string | 库存状态（“有货”或“缺货”） |
| qty | string | 库存数量 |
| product_addtime | string | 商品上架时间（格式：YYYY-MM-DD HH:MM:SS） |
| is_wish | integer | 是否为收藏商品（1=是，0=否） |
| is_new | integer | 是否为最近上架（1=是，0=否） |
| is_seckill | integer | 是否为秒杀商品（1=是，0=否） |
| seckill_product_price | string | 秒杀价格（is_seckill=1时有效） |
| guide_price | string | 指导价（参考价格） |
| is_hot_sale | integer | 是否为热销商品（1=是，0=否） |
| month_sales | string | 商品月销量 |
| product_sales | string | 商品销量 |
| product_image | string | 商品主图URL |
| product_certificate | array | 商品证书列表（包含证书缩写、颜色、ID） |
| delivery_regions | object | 各发货区域的价格和库存信息（键为发货区域ID） |
| product_categories | array | 商品分类信息（包含多级分类） |
| 字段 | 类型 | 说明 |
|---|---|---|
| abbreviation | string | 证书缩写（如FDA、CN、MSDS等） |
| color | string | 证书标识颜色（用于前端展示） |
| id | integer | 证书ID |
| 字段 | 类型 | 说明 |
|---|---|---|
| delivery_region_id | integer | 发货区域ID |
| delivery_region_name | string | 发货区域名称（如“美国”“中国”） |
| product_price | string | 该区域的商品价格 |
| qty | string | 该区域的库存数量 |
| 字段 | 类型 | 说明 |
|---|---|---|
| length | string | 商品长度 |
| width | string | 商品长度 |
| height | string | 产品分类上级ID |
| inch | string | 长宽高长度单位 |
调用示例
URL请求
请求示例
成功返回示例
{
"code": 0,
"msg": "",
"data": {
"total": 21382,
"page": 1,
"list": [
{
"product_sku_id": 20696,
"product_id": 15063,
"product_sku": "hsyx-黄色圆形海绵",
"delivery_region_id": 5,
"product_sku_is_default": 1,
"product_sku_hs_code": "3402509000",
"seckill_product_price": null,
"customer_wishlist_id": null,
"product_name": "Jue-Fish 家用清洁吸水擦拭海绵 不沾灰皮革金属玻璃擦拭毛巾吸水无痕收水巾",
"month_sales": "0",
"product_price": "¥0.50",
"qty": 999999,
"product_addtime": "2022-11-16 18:30:24",
"is_wish": 0,
"is_new": 0,
"is_seckill": 0,
"is_hot_sale": 0,
"month_sale": 100,
"product_sales": 100,
"product_images": "[\"westmonth/SKUDatum/jstProducts/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-1.jpg\", \"westmonth/SKUDatum/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-94167148.jpg\", \"westmonth/SKUDatum/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-61520405.jpg\", \"westmonth/SKUDatum/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-76291634.jpg\", \"westmonth/SKUDatum/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-59081492.jpg\", \"westmonth/SKUDatum/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-26275465.jpg\"]",
"product_certificate": [],
"delivery_regions": {
"5": [
{
"delivery_region_id": 5,
"delivery_region_name": "中国",
"product_price": "¥0.50",
"qty": 999999
}
],
"16": [
{
"delivery_region_id": 16,
"delivery_region_name": "俄罗斯",
"product_price": "¥28.00",
"qty": "100"
}
]
},
"product_categories": [
{
"category_id": 100130,
"category_name": "家居用品",
"parent_id": 0,
"level": 1
},
{
"category_id": 100321,
"category_name": "家居清洁",
"parent_id": 100130,
"level": 2
},
{
"category_id": 100326,
"category_name": "清洁工具",
"parent_id": 100321,
"level": 3
}
],
"multiple_prices": [],
"product_attributes": [],
"stock_status": "有货",
"product_image": "https://oss.westmonth.com/westmonth/SKUDatum/jstProducts/hsyx-黄色圆形海绵/mainpicture/hsyx-黄色圆形海绵-1.jpg?x-oss-process=image/resize,m_lfit,w_500",
"image": ""
}
]
}
}失败返回示例
{
"code": 3,
"msg": "授权无效 authorization timestamp error",
"data": []
}错误处理
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|
注意事项
/openapi/productCategory/getDeliveryRegions）获取有效ID常见问题
Q1：如何按价格从高到低排序商品？
Q2：如何查询同时支持多个发货区域的商品？
Q3：商品的库存状态（stock_status）为“有货”但qty显示为0是什么原因？
版本历史
| 版本 | 日期 | 修改说明 |
|---|---|---|
| v1.0 | 2024-10-15 | 初始版本，支持基本商品列表查询 |
| v1.1 | 2025-03-01 | 新增product_sku_ids参数，支持精确查询指定SKU |
| v1.2 | 2025-06-10 | 优化库存状态判断逻辑，新增product_name_en字段支持英文名称 |
请求参数
Query 参数
Header 参数
请求示例代码
返回响应
修改于 2026-02-24 03:17:33