English

简体中文

English

简体中文

About Theme ​

Access scope

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

The ability to design, upload, and modify themes, suitable for automated operations and custom theme development.

Endpoints

GET /api/202412/themes: Get theme list

GET /api/202412/themes/{themeId}/assets: Get theme asset

Theme Object ​

A store can have up to 20 themes, but only one can be the published theme, which is the one customers see when they visit the online store. Each theme package contains multiple Asset resources. If you want to update the theme package or any assets within it, you can either upload the modified theme package or update the individual Asset resource files.

Properties ​

themeobjectrequired
Theme list.
- Hide child properties
isCurrentbooleanrequired
Whether the store is currently themed，true or false.
shopThemeNamestringrequired
shop theme name.
createTimestringrequired
shop theme create time (ISO 8601 format).
shopThemeIdstringrequired
shop theme id.
updateTimestringrequired
shop theme update time (ISO 8601 format).
statusstringrequired
Installation status, enumeration: INIT initialization, SUCCESS install success, FAIL install fail.
bash
{
  "theme": {
    "isCurrent": "false",
    "shopThemeName": "Down",
    "createTime": "2024-18-12T08:18:49Z",
    "shopThemeId": "1",
    "updateTime": "2024-18-12T08:18:49Z",
    "status": "INIT"
  }
}

GET Get theme list ​

Get themes list.

Access scope

Requires ANY of the following access scopes: read_themes

Endpoint

GET /api/202412/themes 

Request Params

{}

Response Data

themesarrayrequired
Theme list.
- Hide child properties
isCurrentbooleanrequired
Whether the store is currently themed，true or false.
shopThemeNamestringrequired
shop theme name.
createTimestringrequired
shop theme create time (ISO 8601 format).
shopThemeIdstringrequired
shop theme id.
updateTimestringrequired
shop theme update time (ISO 8601 format).
statusstringrequired
Installation status, Enum: INIT - initialization, SUCCESS - install success, FAIL - install fail.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/themes" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "themes": [
    {
      "isCurrent": "false",
      "shopThemeName": "Down",
      "createTime": "2025-01-10T11:00:00Z",
      "shopThemeId": "1",
      "updateTime": "2025-01-10T11:00:00Z",
      "status": "INIT"
    }
  ]
}

GET Get theme asset ​

Retrieve store theme asset information.

Access scope

Requires ANY of the following access scopes: read_themes

Endpoint

GET /api/202412/themes/{themeId}/assets 

Request Params

assetNamestringrequired
The resource address of the store theme.
themeIdstringrequired
Unique identification of the theme.

Response Data

assetobjectrequired
Asset information of the store.
- Hide child properties
createTimestringrequired
shop file create time(ISO 8601 format).
contextstringrequired
shop file context.
updateTimestringrequired
shop file update time(ISO 8601 format).
fileTypestringrequired
shop file type, css、gif、js、json、liquid、sv... .
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/themes/{themeId}/assets" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "asset": {
    "createTime": "2025-01-10T11:00:00Z",
    "context": "{\"color_scheme\":\"scheme-1\"}",
    "updateTime": "2025-01-10T11:00:00Z",
    "fileType": "json"
  }
}