Product Collection Get Product List API 文档

得到专辑的商品列表

接口信息

接口地址: {your-site-url}/api/skill/product-collection/get-collect-product-list
基础 URL: {your-site-url} 需替换为你自己的独立站 URL 地址，如 https://your-domain.com/apimanager666
请求方式: POST
Content-Type: application/json
说明: 此接口为查询接口，用于获取指定专辑下的商品列表

认证

请求头中需要携带 skill-access-token：

Header	值
`skill-access-token`	`{your-skill-access-token}` （请替换为你自己的 token）

请求参数 (Query String)

字段	类型	必填	说明
`collection_id`	int	✅ 必填	专辑 ID
`pageNum`	int	选填	第几页，不填写则默认第 1 页
`pageSize`	int	选填	每页的数据个数，不填写则使用系统默认值

请求示例

cURL

curl --location --request POST '{your-site-url}/api/skill/product-collection/get-collect-product-list?collection_id=364&pageNum=1&pageSize=20' \
--header 'skill-access-token: {your-skill-access-token}' \
--data-raw ''

返回结果

code 为 200 表示调用成功；code 不为 200 表示调用失败。

成功响应

{
    "code": 200,
    "data": {
        "list": [
            {
                "id": 8664,
                "shop_id": 15,
                "product_id": 4976,
                "position": 1,
                "product": {
                    "id": 4976,
                    "title": "Yoga: a Manual for Life",
                    "status": 2,
                    "image": {
                        "id": 31734,
                        "product_id": 4976,
                        "src": "https://cdn.shopify.com/s/files/1/0591/1350/4958/products/7-a_76a9c7e9-5431-4bd2-acc2-c9d4bbf1934f.jpg?v=1628348624",
                        "width": 0,
                        "height": 0,
                        "ratio": "1.00",
                        "alt": "",
                        "position": 1,
                        "created_at": 1778303759,
                        "updated_at": 1778303759
                    }
                }
            }
        ],
        "total": 100,
        "pageSize": 20,
        "totalPage": 5
    },
    "message": "success"
}

返回字段说明

字段	类型	说明
`code`	Number	状态码，`200` 表示成功
`message`	String	执行结果的文字描述
`data`	Object	返回数据

data 顶层字段

字段	类型	说明
`total`	int	商品总数
`pageSize`	int	每页的数据个数
`totalPage`	int	总页数
`list`	Array[Object]	专辑商品列表

data.list 子项

字段	类型	说明
`id`	int	关联记录 ID
`shop_id`	int	店铺 ID
`product_id`	int	商品 ID
`position`	int	商品在专辑中的排序位置。`null` 表示未设置排序
`product.id`	int	商品 ID
`product.title`	string	商品标题
`product.status`	int	商品状态。`1` 上架，`2` 下架

product.image 子项

字段	类型	说明
`id`	int	图片 ID
`product_id`	int	商品 ID
`src`	string	图片 URL
`width`	int	图片宽度
`height`	int	图片高度
`ratio`	string	图片宽高比
`alt`	string	图片 alt 文本
`position`	int	图片排序（`1` 为主图）
`created_at`	int	创建时间戳
`updated_at`	int	更新时间戳

注意事项

collection_id 为必填
pageNum 和 pageSize 为选填，用于分页
返回结果中 position 为 null 表示该商品在专辑中未设置排序位置

results matching ""

No results matching ""