put https://{shopdomain}.myshoplaza.com/openapi/2022-01/redirects/
Requires
write_shop_navigationaccess 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
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | Unique identifier of the redirect. | 4540188244553 |
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
from_url | string | Yes | The original URL to be redirected. | /collections/hot-selling |
redirect_url | string | Yes | The target URL for the redirection. | /collections/test1567 |
status | string | Yes | Status of the redirect (open or close). | open |
Response Explanation
Public Response Parameters
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 | |
| 404 | Not Found | "Data not found" | |
| 422 | Unprocessable Entity | "Target is invalid" |