put https://{shopdomain}.myshoplaza.com/openapi/2022-01/pages/
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
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
id | string | The ID of the page to update. | Yes | 15978 |
Body Parameters
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
title | string | The title of the page. | No | "Updated Page" |
content | string | Page content in HTML format. | No | "<p>Updated content</p>" |
url | string | The URL of the page. | No | "/pages/updated" |
meta_title | string | The SEO title of the page. | No | "Updated Meta Title" |
meta_keyword | string | The SEO keywords of the page. | No | "keyword1, keyword2" |
meta_description | string | The SEO description of the page. | No | "Updated description" |
independent_seo | boolean | Decide whether the SEO title is edited independently. | No | true |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
id | string | The ID of the updated page. | 15978 |
title | string | The updated title of the page. | "Updated Page" |
content | string | The updated content of the page. | "<p>Updated content</p>" |
url | string | The updated URL of the page. | "/pages/updated" |
meta_title | string | The updated SEO title of the page. | "Updated Meta Title" |
meta_keyword | string | The updated SEO keywords of the page. | "keyword1, keyword2" |
meta_description | string | The updated SEO description of the page. | "Updated description" |
independent_seo | boolean | The updated SEO independence status. | true |
status | integer | The status of the page (1 for active). | 1 |
created_at | string | The creation timestamp of the page. | "1714377411" |
updated_at | string | The updated timestamp of the page. | "1714377899" |
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 |