get https://{shopdomain}.myshoplaza.com/openapi/2022-01/redirects
Requires
read_shop_navigationaccess scope. More access scope
The Redirect List API retrieves a list of all redirects configured in your store, including their details and statuses.
This API is especially useful for:
- Viewing all configured redirects in one place.
- Monitoring and managing URL redirections in your store.
- Debugging or verifying multiple redirect entries.
Request Parameters
Public Request Parameters
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
count | integer | The total number of redirects in the store. | 2 |
redirects | array | A list of redirect objects. | See below for redirect fields. |
redirects.id | string | Unique identifier for the redirect. | 373043170117713580 |
redirects.store_id | integer | ID of the store where the redirect is configured. | 633130 |
redirects.status | string | Status of the redirect. | open |
redirects.from_url | string | The original URL specified for redirection. | /collections/hot-selling1 |
redirects.redirect_url | string | The target URL specified for the redirection. | /collections/test1567 |
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 |