关于系列

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

产品系列 是指商家将相关产品分组在一起形成的集合，通过将相关产品进行分组管理，帮助商家更好地展示和管理商品。Genstore 提供了一系列 RESTful 接口，支持产品系列的创建、管理、查询等操作，助力商家打造更好的商品浏览和购物体验。

核心功能

基础操作：创建产品系列、更新产品系列信息、删除产品系列。
信息查询：查询系列详情、查询系列列表、统计系列数量。
管理产品系列中的商品：新增系列商品、移除系列商品、查询系列商品列表。

应用场景

商品分类展示：商品运营团队可通过接口组织商品集合、配置展示规则、管理季节性陈列，打造富有吸引力的购物体验，提升品类表现。
营销活动支持：营销团队可快速创建和更新主题集合、排期促销展示、协调多渠道商品上新，最大化活动效果和商品曝光。
商品管理优化：商品管理员可高效维护多个集合、跨品类同步商品信息、批量更新集合规则，简化集合维护工作，降低运营成本。

接口

POST /api/202412/collections: 创建产品系列

POST /api/202412/collections/collect: 新增产品到系列

PUT /api/202412/collections/{collectionId}: 修改产品系列

DELETE /api/202412/collections/{collectionId}: 删除产品系列

DELETE /api/202412/collections/collect: 从系列移除产品

GET /api/202412/collections/{collectionId}: 获取系列详情

GET /api/202412/collections: 获取系列列表

GET /api/202412/collections/count: 查询产品系列数量

产品系列对象

产品系列业务域对象。

属性

collectionobject

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列；2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线商店。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

collectionIdnumber

产品系列唯一标识符。

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品唯一标识符列表。

产品系列对象

bash

{
  "collection": {
    "collectionType": "1",
    "image": {
      "src": "https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
    },
    "ruleSet": {
      "appliedDisjunctively": "true",
      "rules": [
        {
          "condition": "["test"]",
          "column": "title",
          "relation": "equals"
        }
      ]
    },
    "bodyHtml": "<p>Test Description</p>",
    "published": "true",
    "title": "Collection Title",
    "collectionId": "102984300756584",
    "collects": "[102744899756584,102744899756583]",
    "countGoodsNum": "3"
  }
}

`POST` 创建产品系列

创建一个产品系列。

访问范围

需要以下任意访问权限: write_products

接口

POST /api/202412/collections

请求参数

collectionobject

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列；2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线商店。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品唯一标识符列表。

响应数据

collectionobject

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列；2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线商店。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

collectionIdnumber

系列的唯一标识符。

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品唯一标识符列表。

POST /api/202412/collections

bash

curl -X POST \ 
https://{shop}.genmystore.com/api/202412/collections" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"collection":{
		"collectionType":"1",
		"image":{
			"src":"https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
		},
		"ruleSet":{
			"appliedDisjunctively":"true",
			"rules":[
				{
					"condition":"[\"test\"]",
					"column":"title",
					"relation":"equals"
				}
			]
		},
		"bodyHtml":"<p>Test Description</p>",
		"published":"true",
		"title":"Collection Title",
		"collects":"[102744899756584,102744899756583]",
		"countGoodsNum":"3"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "collection": {
    "collectionType": "1",
    "image": {
      "src": "https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
    },
    "ruleSet": {
      "appliedDisjunctively": "true",
      "rules": [
        {
          "condition": "[\"test\"]",
          "column": "title",
          "relation": "equals"
        }
      ]
    },
    "bodyHtml": "<p>Test Description</p>",
    "published": "true",
    "title": "Collection Title",
    "collectionId": "102984300756584",
    "collects": "[102744899756584,102744899756583]",
    "countGoodsNum": "3"
  }
}

`POST` 新增产品到系列

新增一个产品到具体的产品系列中。

访问范围

需要以下任意访问权限: write_products

接口

POST /api/202412/collections/collect

请求参数

collectobject

- 收起属性

productIdsarray

产品唯一标识符列表。

collectionIdnumber

产品系列唯一标识符。

响应数据

collectionsobject

- 收起属性

resultboolean

是否新增成功。

POST /api/202412/collections/collect

bash

curl -X POST \ 
https://{shop}.genmystore.com/api/202412/collections/collect" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"collect":{
		"productIds":"[102745723756584]",
		"collectionId":"11017685756584"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "collections": {
    "result": "true"
  }
}

`PUT` 修改产品系列

修改一个产品系列。

访问范围

需要以下任意访问权限: write_products

接口

PUT /api/202412/collections/{collectionId}

请求参数

collectionobject

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列；2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线商店。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

collectionIdnumber

产品系列唯一标识符。

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品系列唯一标识符列表。

响应数据

collectionobject

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列；2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

collectionIdnumber

产品系列唯一标识符。

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品系列唯一标识符列表。

PUT /api/202412/collections/{collectionId}

bash

curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/collections/{collectionId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"collection":{
		"collectionType":"1",
		"image":{
			"src":"https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
		},
		"ruleSet":{
			"appliedDisjunctively":"true",
			"rules":[
				{
					"condition":"[\"test\"]",
					"column":"title",
					"relation":"equals"
				}
			]
		},
		"bodyHtml":"<p>Test Description</p>",
		"published":"true",
		"title":"Collection Title",
		"collectionId":"102984300756584",
		"collects":"[102744899756584,102744899756583]",
		"countGoodsNum":"3"
	}
}'

响应

json

HTTP/1.1 200 OK
{
  "collection": {
    "collectionType": "1",
    "image": {
      "src": "https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
    },
    "ruleSet": {
      "appliedDisjunctively": "true",
      "rules": [
        {
          "condition": "[\"test\"]",
          "column": "title",
          "relation": "equals"
        }
      ]
    },
    "bodyHtml": "<p>Test Description</p>",
    "published": "true",
    "title": "Collection Title",
    "collectionId": "102984300756584",
    "collects": "[102744899756584,102744899756583]",
    "countGoodsNum": "3"
  }
}

`DELETE` 删除产品系列

删除一个产品系列。

访问范围

需要以下任意访问权限: write_products

接口

DELETE /api/202412/collections/{collectionId}

请求参数

collectionIdnumber

产品系列唯一标识符。

响应数据

{}

DELETE /api/202412/collections/{collectionId}

bash

curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/collections/{collectionId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{}

`DELETE` 从系列移除产品

删除产品系列中的具体商品。

访问范围

需要以下任意访问权限: write_products

接口

DELETE /api/202412/collections/collect

请求参数

collectobject

- 收起属性

productIdsarray

产品唯一标识符列表。

collectionIdnumber

产品系列唯一标识符。

响应数据

collectionsobject

返回系列详情。

- 收起属性

resultboolean

是否删除成功。

DELETE /api/202412/collections/collect

bash

curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/collections/collect" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "collections": {
    "result": "true"
  }
}

`GET` 获取系列详情

查看单个产品系列详情。

访问范围

需要以下任意访问权限: write_products read_products

接口

GET /api/202412/collections/{collectionId}

请求参数

collectionIdnumber

系列唯一标识符列表。

响应数据

collectionobject

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列；2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线商店。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

collectionIdnumber

系列唯一标识符。

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品ID列表。

GET /api/202412/collections/{collectionId}

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/collections/{collectionId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "collection": {
    "collectionType": "1",
    "image": {
      "src": "https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
    },
    "ruleSet": {
      "appliedDisjunctively": "true",
      "rules": [
        {
          "condition": "[\"test\"]",
          "column": "title",
          "relation": "equals"
        }
      ]
    },
    "bodyHtml": "<p>Test Description</p>",
    "published": "true",
    "title": "Collection Title",
    "collectionId": "102984300756584",
    "collects": "[102744899756584,102744899756583]",
    "countGoodsNum": "3"
  }
}

`GET` 获取系列列表

查询产品系列列表。

访问范围

需要以下任意访问权限: write_products read_products

接口

GET /api/202412/collections

请求参数

titlestring

产品系列标题。

collectionTypenumber

产品系列类型。

idsarray

产品系列唯一标识符列表。

publishedStatusstring

是否将资源发布到的在线商店。枚举值：published - 只展示发布到在线商店的系列; unpublished - 只展示未发布到在线商店的系列; any - 展示所有。

sortOrderstring

列表排序规则。枚举值：created - 按创建时间正序；created-desc - 按创建时间倒序；updated - 按更新时间正序；update-desc - 按更新时间倒序。

pageTokennumber

代表某一分页的游标。

limitnumber

每页限制数量。

响应数据

collectionsarray

返回系列的详细信息。

- 收起属性

titlestring

产品系列标题。

bodyHtmlstring

产品系列描述，支持 HTML 格式。

collectionTypenumber

产品系列类型。枚举值：1 - 定制系列; 2 - 智能系列。

imageobject

产品系列图片。

+ 展开属性

publishedboolean

是否发布到在线商店。

ruleSetobject

智能产品系列中将产品分配给系列的规则。

+ 展开属性

collectionIdnumber

产品系列唯一标识符。

countGoodsNumnumber

系列关联的产品数量。

collectsarray

系列关联产品唯一标识符列表。

GET /api/202412/collections

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/collections" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "collections": [
    {
      "collectionType": "1",
      "image": {
        "src": "https://cdn.shopify.com/s/files/1/0600/8317/5513/files/wax-special_150x.png?v=1716260624"
      },
      "ruleSet": {
        "appliedDisjunctively": "true",
        "rules": [
          {
            "condition": "[\"test\"]",
            "column": "title",
            "relation": "equals"
          }
        ]
      },
      "bodyHtml": "<p>Test Description</p>",
      "published": "true",
      "title": "Collection Title",
      "collectionId": "102984300756584",
      "collects": "[102744899756584,102744899756583]",
      "countGoodsNum": "3"
    }
  ]
}

`GET` 查询产品系列数量

查询产品系列数量。

访问范围

需要以下任意访问权限: write_products read_products

接口

GET /api/202412/collections/count

请求参数

{}

响应数据

countnumber

返回系列数量。

GET /api/202412/collections/count

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/collections/count" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "count": "3"
}

关于系列

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

核心功能

基础操作：创建产品系列、更新产品系列信息、删除产品系列。
信息查询：查询系列详情、查询系列列表、统计系列数量。
管理产品系列中的商品：新增系列商品、移除系列商品、查询系列商品列表。

应用场景

商品分类展示：商品运营团队可通过接口组织商品集合、配置展示规则、管理季节性陈列，打造富有吸引力的购物体验，提升品类表现。
营销活动支持：营销团队可快速创建和更新主题集合、排期促销展示、协调多渠道商品上新，最大化活动效果和商品曝光。
商品管理优化：商品管理员可高效维护多个集合、跨品类同步商品信息、批量更新集合规则，简化集合维护工作，降低运营成本。

产品系列对象

接口

GET /api/202412/collections/count

产品

变体

系列

库存

类目

礼品卡

厂商

订单

履约

退货

客户

主题

店铺

市场

翻译

元字段

元字段定义

账户

交易

折扣

授权

消息订阅

关于 系列 ​

产品系列 对象 ​

属性 ​

POST 创建产品系列 ​

请求参数

响应数据

POST 新增产品到系列 ​

请求参数

响应数据

PUT 修改产品系列 ​

请求参数

响应数据

DELETE 删除产品系列 ​

请求参数

响应数据

DELETE 从系列移除产品 ​

请求参数

响应数据

GET 获取系列详情 ​

请求参数

响应数据

GET 获取系列列表 ​

请求参数

响应数据

GET 查询产品系列数量 ​

请求参数

响应数据

关于 系列 ​

产品系列 对象 ​

属性 ​

POST 创建产品系列 ​

POST 新增产品到系列 ​

PUT 修改产品系列 ​

DELETE 删除产品系列 ​

DELETE 从系列移除产品 ​

GET 获取系列详情 ​

GET 获取系列列表 ​

GET 查询产品系列数量 ​

关于系列

产品系列对象

属性

`POST` 创建产品系列

`POST` 新增产品到系列

`PUT` 修改产品系列

`DELETE` 删除产品系列

`DELETE` 从系列移除产品

`GET` 获取系列详情

`GET` 获取系列列表

`GET` 查询产品系列数量

关于系列

产品系列对象

属性

`POST` 创建产品系列

`POST` 新增产品到系列

`PUT` 修改产品系列

`DELETE` 删除产品系列

`DELETE` 从系列移除产品

`GET` 获取系列详情

`GET` 获取系列列表

`GET` 查询产品系列数量