English

简体中文

English

简体中文

About Collection ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Product Collections are essential organizational units in Genstore's product management system, enabling merchants to group related products for better presentation and management. Genstore provides a series of RESTful interfaces supporting the creation, management, and query of product collections, helping merchants create better browsing and shopping experiences.

Core Features

  • Basic Operations: Create product series, update series information, delete product series.
  • Information Query: Get series details, list series, count series.
  • Manage Products in Collections: Add products to series, remove products from series, list series products.

Use Cases

  • Product Category Display: Merchandising teams can organize products into collections, configure display rules, and manage seasonal layouts through the API, creating engaging shopping experiences that drive category performance.
  • Marketing Campaign Support: Marketing teams can quickly create and update themed collections, schedule promotional displays, and coordinate multi-channel product launches, maximizing campaign effectiveness and product visibility.
  • Product Management Optimization: Product managers can efficiently maintain multiple collections, synchronize product information across categories, and update collection rules in batch, streamlining collection maintenance and reducing operational overhead.

Endpoints

EVENT collections/create: Create a product collection

EVENT collections/update: Update a collection

EVENT collections/delete: Delete a collection

Product Collection Object ​

The product collection object.

Properties ​

collectionobject
Return collections details.
- Hide child properties
titlestring
Product collection title.
bodyHtmlstring
Product collection description.
collectionTypenumber
Product collection type. Enumeration values: 1 - custom collection; 2 - smart collection.
imageobject
Product collection image.
+ Show child properties
publishedboolean
Whether published to the online store.
ruleSetobject
Rules for assigning products to collections in smart collections.
+ Show child properties
collectionIdnumber
The unique identifiers for product collections.
countGoodsNumnumber
Number of products associated with the collection.
collectsarray
List of unique identifiers for related collection products.
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"
  }
}

EVENT Create a product collection ​

Occurs whenever a collection is created.

Access scope

Requires ANY of the following access scopes: write_products read_products

Topic

EVENT collections/create 

Event Data

collectionobject
Return collections details.
- Hide child properties
titlestring
Product collection title.
bodyHtmlstring
Product collection description.
collectionTypenumber
Product collection type. Enumeration values: 1 - custom collection; 2 - smart collection.
imageobject
Product collection image.
+ Show child properties
ruleSetobject
Rules for assigning products to collections in smart collections.
+ Show child properties
collectionIdnumber
The unique identifiers for product collections.
countGoodsNumnumber
Number of products associated with the collection.
handlestring
A unique, human-readable string of the collection's title.
json
{
  "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>",
    "handle": "",
    "title": "Collection Title",
    "collectionId": "102984300756584",
    "countGoodsNum": "3"
  }
}

EVENT Update a collection ​

Occurs whenever a collection is updated, including whenever products are added or removed from the collection.

Access scope

Requires ANY of the following access scopes: write_products read_products

Topic

EVENT collections/update 

Event Data

collectionobject
Return collections details.
- Hide child properties
titlestring
Product collection title.
bodyHtmlstring
Product collection description.
collectionTypenumber
Product collection type. Enumeration values: 1 - custom collection; 2 - smart collection.
imageobject
Product collection image.
+ Show child properties
ruleSetobject
Rules for assigning products to collections in smart collections.
+ Show child properties
collectionIdnumber
The unique identifiers for product collections.
countGoodsNumnumber
Number of products associated with the collection.
handlestring
A unique, human-readable string of the collection's title.
json
{
  "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>",
    "handle": "",
    "title": "Collection Title",
    "collectionId": "102984300756584",
    "countGoodsNum": "3"
  }
}

EVENT Delete a collection ​

Occurs whenever a collection is deleted.

Access scope

Requires ANY of the following access scopes: write_products read_products

Topic

EVENT collections/delete 

Event Data

collectionIdstring
A unique identifiers for product collections.
json
{
  "collectionId": "1234"
}