get
https://{shopdomain}.myshoplaza.com/openapi/2022-01/themes//download
Requiresread_themesaccess scope. More access scope
The Download Theme API allows users to download a theme file in binary format (ZIP). This enables users to programmatically retrieve the theme for offline storage or further processing.
This API is especially useful for:
- Backing up themes for recovery or archival purposes.
- Programmatically managing themes in external systems.
- Exporting themes for customization or testing.
Request Parameters
Public Request Parameters
Path Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| theme_id | string | Required. The ID of the theme to download. | 1500021b-88ed-4750-bbc5-97ec98351dc0 |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
| Binary Content | binary | The theme file in ZIP format. | N/A |
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 |