get https://{shopdomain}.myshoplaza.com/openapi/2022-01/themes
Requires
read_themesaccess scope. More access scope
The Get Theme List API retrieves a list of all themes available for a specific shop, including their details such as version, locale, and status.
This API is especially useful for:
- Fetching all available themes for a shop.
- Managing and verifying the themes' versions and statuses.
- Identifying published and unpublished themes.
Request Parameters
Public Request Parameters
Response Explanation
Public Response Parameters
Successful Response
| Name | Type | Example | Description |
|---|---|---|---|
count | string | 2 | Total number of themes available. |
themes | array | Array of theme objects. | |
themes.id | string | 4fe3e348-eefd-4f55-aa13-9f123a2c984b | Theme's unique identifier. |
themes.name | string | Nova-2023-main | Theme name. |
themes.locale | string | en-US | Theme locale. |
themes.c_version | string | 1.0.0 | Client version. |
themes.published | string | 0 | Whether the theme is published (0 or 1). |
themes.updated_at | string | 1714461023 | Timestamp of the last update. |
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 |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| 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 |