English

简体中文

English

简体中文

Appearance

About Product Category ​

Access scope

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

Category Search is a core search functionality within Genstore's product classification system, providing quick category retrieval capabilities through efficient RESTful interfaces. This feature aims to optimize category discovery experience, improve product finding efficiency, and help merchants build better product classification navigation systems.

Core Features

Support flexible searching through category names, descriptions, and other attributes, helping users quickly locate target categories.

Use Cases

  • Category Navigation Enhancement: E-commerce managers can organize product hierarchies, customize category relationships, and optimize search parameters through the API, enabling customers to quickly find relevant products and improve discovery efficiency.
  • Smart Product Recommendations: Marketing teams can leverage category data to configure related product suggestions, implement cross-category promotions, and personalize product discovery flows, increasing customer engagement and conversion rates.

Endpoints

GET /api/202412/category/search: Get product category list

Product category Object ​

The product category object.

Properties ​

productCategoryobject
The product category.
- Hide child properties
categoryIdnumber
An unsigned 64-bit integer that's used as a unique identifier for the product category.
categoryNamestring
The name of the product category.
parentCategoryIdnumber
An unsigned 64-bit integer that's used as a unique identifier for the parent product category.
bash
{
  "productCategory": {
    "parentCategoryId": "209148956144",
    "categoryName": "pet",
    "categoryId": "209148956145"
  }
}

GET Get product category list ​

Retrieve a list of product categories.

Access scope

Requires ANY of the following access scopes: write_products read_products

Endpoint

GET /api/202412/category/search 

Request Params

sinceIdstring
Starting resource ID, mainly used for querying pagination starting from sinceId on the homepage.
pageTokenstring
The cursor representing a page will return the homepage data by default.
limitnumber
Page count limit, default limit is 50.
categoryNamestring
The name of the product category.
parentCategoryIdnumber
An unsigned 64-bit integer that's used as a unique identifier for the parent product category.

Response Data

productCategoriesarray
The product category.
- Hide child properties
categoryIdnumber
An unsigned 64-bit integer that's used as a unique identifier for the product category.
categoryNamestring
The name of the product category.
parentCategoryIdnumber
An unsigned 64-bit integer that's used as a unique identifier for the parent product category.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/category/search" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "productCategories": [
    {
      "parentCategoryId": "209148956144",
      "categoryName": "pet",
      "categoryId": "209148956145"
    }
  ]
}