Product List API 文档
接口信息
- 接口地址:
{your-site-url}/api/skill/product/list
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- Content-Type:
application/json
- 说明: 此接口为查询接口,用于获取商品列表
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数 (Query String)
| 字段 |
类型 |
必填 |
说明 |
pageNum |
int |
选填 |
第几页,不填写则默认第 1 页 |
pageSize |
int |
选填 |
每页的数据个数,不填写则使用系统默认值 |
title |
string |
选填 |
通过商品标题字符串进行模糊搜索(LIKE) |
status |
int |
选填 |
商品状态,1 为上架,2 为下架 |
collection_ids |
string |
选填 |
通过商品专辑过滤,多个专辑 ID 用英文逗号隔开(如 343,32)。商品与专辑是多对多关系,此处为或关系:存在于这些专辑中的商品都会被搜索出来 |
tags |
string |
选填 |
通过商品 tag 搜索,多个 tag 用英文逗号隔开(如 red,black)。商品与 tag 是多对多关系 |
tags_type |
string |
选填 |
tag 搜索的关系类型。or 为或关系,and 为并关系。默认值为 or |
id_begin |
int |
选填 |
商品 ID 过滤区间下限,商品 ID 大于等于该值 |
id_end |
int |
选填 |
商品 ID 过滤区间上限,商品 ID 小于等于该值 |
created_at_begin |
string |
选填 |
商品创建时间过滤区间下限,创建时间大于等于该值,格式:2016-01-01 00:00:00 |
created_at_end |
string |
选填 |
商品创建时间过滤区间上限,创建时间小于等于该值,格式:2016-01-01 00:00:00 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/product/list?pageNum=1&pageSize=20&title=black&status=1&collection_ids=343,32&tags=red,black&tags_type=and&id_begin=1000&id_end=5000&created_at_begin=2026-01-01 00:00:00&created_at_end=2026-05-01 23:59:59' \
--header 'skill-access-token: {your-skill-access-token}'
返回结果
成功响应
{
"code": 200,
"data": {
"list": [
{
"id": 4625,
"handle": "morden-lighting-nordic-white-black-lamp-shade-floor-lamp-wooden-support-standing-light",
"spu": "7218747113643",
"title": "Nordic White Black Lamp Floor Lamp Wooden Standing",
"sub_title": "",
"body_html": "...",
"meta_title": "Nordic White Black Lamp Floor Lamp Wooden Standing",
"meta_keywords": "",
"meta_description": "...",
"status": 1,
"availability": 1,
"type": 2,
"vendor": "Lighting Made",
"qty": 198,
"created_at": "2026-02-08 10:35:42",
"updated_at": "2026-05-05 11:10:19",
"inventory_police": 1,
"inventory_police_type": 1,
"variant_need_image": 1,
"variant_need_note": 1,
"variants": [
{
"id": 42432,
"product_id": 4625,
"title": "White",
"price": "470.00",
"compare_at_price": "500.00",
"cost_price": "0.00",
"wholesale_price": [
{ "qty": 2, "price": "38.99" },
{ "qty": 5, "price": "18.99" }
],
"sku": "LM4540066",
"gram": 2267,
"position": 0,
"barcode": "",
"image_id": 30233,
"qty": 98,
"option1": "White",
"option2": "",
"option3": "",
"weight": "5.00",
"weight_unit": "lb",
"sale_count": 0,
"note": "",
"remote_id": 0,
"source_id": "",
"image": "https://cdn12.fecmall.com/product/15/image/2026/02/08/1e0c57ae313ecb06f730ee2e27f31c42.jpg"
}
],
"options": [
{
"id": 5135,
"product_id": 4625,
"name": "Lampshade Color",
"position": 1,
"items": ["White", "Black"]
}
],
"images": [
{
"id": 30232,
"product_id": 4625,
"position": 1,
"src": "https://cdn12.fecmall.com/product/15/image/2026/02/08/90667114713397b934d471526f73bfd4.jpg",
"alt": "",
"width": 800,
"height": 800,
"ratio": "1.00"
}
],
"collectionIds": [343, 327, 322, 344, 345],
"tagIds": [
{
"product_id": 4625,
"tag_id": 10,
"tag": { "title": "red", "id": 10, "first_letter": "r" }
}
]
}
],
"total": 1,
"pageSize": 20,
"totalPage": 1
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
返回数据 |
data 顶层字段
| 字段 |
类型 |
说明 |
total |
Number |
列表总数 |
pageSize |
Number |
每页的数据个数 |
totalPage |
Number |
总页数 |
list |
Array |
商品列表 |
data.list 子项 - 商品基本信息
| 字段 |
类型 |
说明 |
id |
int |
产品 ID |
spu |
string |
产品 SPU 编码 |
title |
string |
产品标题 |
sub_title |
string |
产品副标题 |
body_html |
string |
产品描述(HTML) |
handle |
string |
商品 URL handle,用于前台商城访问商品页面的 URL path |
meta_title |
string |
SEO 标题(meta title) |
meta_keywords |
string |
SEO 关键字(meta keywords) |
meta_description |
string |
SEO 描述(meta description) |
data.list 子项 - 商品状态/配置
| 字段 |
类型 |
说明 |
status |
int |
产品状态。1 上架,2 下架。默认上架 |
type |
int |
产品规格类型。1 单规格,2 多规格(如颜色、尺码) |
availability |
int |
可售状态。1 代表可售,2 代表商品不可用 |
qty |
int |
总库存数量 |
vendor |
string |
产品厂家/品牌名称 |
virtual_sales_count |
int |
产品虚拟销量 |
variant_need_image |
int |
规格是否需要图片。1 需要,2 不需要。默认 1 |
variant_need_note |
int |
变体是否需要备注。1 需要,2 不需要 |
inventory_police |
int |
是否跟踪库存。1 跟踪,2 不跟踪。默认 1 |
inventory_police_type |
int |
库存策略。1 库存为0允许购买,2 库存为0不允许购买,3 库存为0自动下架。默认 1 |
created_at |
string |
创建时间 |
updated_at |
string |
更新时间 |
data.list 子项 - variants(产品变体/规格)
当为单规格产品时,该数组只有一个子项。
| 字段 |
类型 |
说明 |
id |
int |
变体 ID |
product_id |
int |
产品 ID |
title |
string |
规格名称 |
price |
float |
售卖价格 |
compare_at_price |
float |
划线价格 |
cost_price |
float |
成本价格 |
wholesale_price |
Array[Object] |
批发价格(见下方子字段) |
sku |
string |
产品 SKU |
gram |
int |
重量(克) |
weight |
float |
重量 |
weight_unit |
string |
重量单位。可选值:g(克)、kg(千克)、lb(磅)、oz(盎司) |
barcode |
string |
条形码 |
qty |
int |
变体库存,默认 0 |
image_id |
int |
图片 ID |
image |
string |
变体图片路径 |
option1 |
string |
规格值 1 |
option2 |
string |
规格值 2 |
option3 |
string |
规格值 3 |
position |
int |
排序位置 |
note |
string |
变体备注 |
sale_count |
int |
销量 |
remote_id |
int |
远程 ID,用于与三方系统同步商品数据,记录三方系统商品 ID,用于商品同步更新 |
source_id |
string |
来源 ID |
wholesale_price 子字段
wholesale_price 是一个数组,每个元素包含:
| 字段 |
类型 |
说明 |
qty |
int |
批发个数 |
price |
string |
批发价格 |
示例:
"wholesale_price": [
{ "qty": 2, "price": "38.99" },
{ "qty": 5, "price": "18.99" }
]
data.list 子项 - options(产品规格定义)
单规格产品为空,多规格产品不为空。
| 字段 |
类型 |
说明 |
id |
int |
Option ID |
product_id |
int |
产品 ID |
name |
string |
规格名称(如 "Lampshade Color"、"Size") |
position |
int |
规格排序 |
items |
Array[string] |
规格子项数组(如 ["White", "Black"]) |
data.list 子项 - images(产品图片)
| 字段 |
类型 |
说明 |
id |
int |
图片 ID |
product_id |
int |
产品 ID |
src |
string |
产品图片 URL 路径 |
alt |
string |
图片 alt 文本 |
position |
int |
图片排序位置,从 1 开始依次递增。标识为 1 的为主图 |
width |
int |
图片宽度(像素) |
height |
int |
图片高度(像素) |
ratio |
string |
图片宽高比 |
data.list 子项 - collectionIds
| 字段 |
类型 |
说明 |
collectionIds |
Array[int] |
产品所属的专辑 ID 数组。一个产品可以对应多个专辑(多对多关系) |
data.list 子项 - tagIds
| 字段 |
类型 |
说明 |
tagIds |
Array[Object] |
产品关联的 tag 数组 |
tagIds[].product_id |
int |
产品 ID |
tagIds[].tag_id |
int |
Tag ID |
tagIds[].tag.id |
int |
Tag 的 ID |
tagIds[].tag.title |
string |
Tag 标题 |
tagIds[].tag.first_letter |
string |
Tag 首字母 |
注意事项
- 所有请求参数均为选填
collection_ids 多个值时是或关系,会搜索出存在于这些专辑中的全部商品
tags 配合 tags_type 使用:tags_type=or(默认)为或关系,tags_type=and 为并关系
id_begin 和 id_end 可单独或组合使用,用于按商品 ID 区间过滤
created_at_begin 和 created_at_end 可单独或组合使用,用于按创建时间区间过滤,时间格式必须为 YYYY-MM-DD HH:mm:ss