delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/redirects/
Requires
write_shop_navigationaccess scope. More access scope
The Delete Redirect API allows you to remove an existing redirect from your shop by providing its unique ID.
This API is especially useful for:
- Removing outdated or invalid redirects.
- Cleaning up unused or deprecated redirect entries.
- Maintaining a streamlined list of active redirects.
Request Parameters
Public Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | Unique identifier of the redirect. | 4540188244553 |
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 | The redirect's id is not found | "record not found" |