delete https://{shopdomain}.myshoplaza.com/openapi/2022-07/pages/
Requires
write_shop_navigationaccess scope. More access scope
The Delete Page API allows you to delete a specific page from your store. This operation is irreversible and removes all associated data of the specified page.
This API is especially useful for:
- Removing obsolete or unwanted pages.
- Managing content dynamically to keep the store's structure organized.
- Clearing outdated or redundant information from your store.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
id | string | The ID of the page to delete. | Yes | 122313 |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
status | integer | Status of the operation (0 for success). | 0 |
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 | Description | Example |
|---|---|---|---|
state | integer | Error state code indicating the type of error. | 1 |
msg | string | Description of the error. | "params err" |
| 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 |