get https://{shopdomain}.myshoplaza.com/openapi/2022-01/themes/
Requires
read_themesaccess scope. More access scope
The Get Theme API retrieves detailed information about a specific theme by its unique ID. This API is particularly useful for managing and verifying theme details, such as version, description, and configuration.
This API is especially useful for:
- Fetching the details of a specific theme.
- Verifying theme configurations and versions.
- Managing themes programmatically for a store.
Request Parameters
Public Request Parameters
Path Parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
theme_id | string | Yes | 1500021b-88ed-4750-bbc5-97ec98351dc0 | Theme's unique identifier. |
Response Explanation
Public Response Parameters
Successful Response
| Name | Type | Example | Description |
|---|---|---|---|
id | string | 1500021b-88ed-4750-bbc5-97ec98351dc0 | Theme's unique identifier. |
merchant_theme_id | string | b3cb6968-2288-4b7e-afcb-62a1b1fa3e4c | Merchant theme ID. |
theme_version_id | string | 16978 | Theme version identifier. |
name | string | Wind | Theme name. |
locale | string | en-US | Theme locale (e.g., en-US, zh-CN). |
desc | object | { "en-US": "Theme description", "zh-CN": "主题描述" } | Multi-language description of the theme. |
type | string | shoplazza | Theme type. |
default | string | 0 | Whether the theme is the default one (0 or 1). |
pc_cover_url | string | https://img.staticdj.com/oss/operation/0e01671232e01d0238c1e88a7a0d783d.png | URL for the PC cover image. |
mobile_cover_url | string | https://img.staticdj.com/oss/operation/50a93783cee55a37e2dcc3781a72d321.png | URL for the mobile cover image. |
published | string | 0 | Whether the theme is published (0 or 1). |
version | string | 24.12.0 | Current theme version. |
c_version | string | 3.0.13 | Current client version. |
newest_c_version | string | 3.0.13 | Newest available client version. |
has_newest_version | boolean | false | Whether the theme has the newest version. |
updated_at | string | 1731696743 | Timestamp of the last update. |
publish_time | string | 1731692171 | Publish timestamp. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |