delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/themes//doc
Requires
write_themesaccess scope. More access scope
The Upload Theme API allows users to upload a theme to the store using a ZIP file. This enables merchants to customize their store's appearance by applying new themes or updating existing ones.
This API is especially useful for:
- Uploading a new theme to customize store appearance.
- Updating or replacing an existing theme for a shop programmatically.
Request Parameters
Public Request Parameters
Path Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
theme_id | String | Yes | The unique ID of the theme. | 1500021b-88ed-4750-bbc5-97ec98351dc0 |
Query Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
type | String | No | The type of file to delete (assets, layout, template, etc.). Defaults to assets. | assets |
location | String | No | The location of the file within the theme. Defaults to a.js. | a.js |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
| Object | A successful response returns an empty object {} indicating the file deletion was successful. | {} |
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 |