get
https://{subdomain}.myshoplaza.com/openapi/2025-06/redirects
Retrieve a list of all url redirect with pagination.
Requireswrite_shop_navigationaccess scope. More access scope
The Create Redirect API allows you to set up a URL redirect in your store, ensuring that users navigating to an outdated or unavailable URL are redirected to the correct location.
This API is especially useful for:
- Managing outdated URLs after updating your store's structure.
- Preventing broken links by redirecting users to active pages.
- Improving SEO by maintaining URL integrity.
Request Parameters
Public Request Parameters
Body Parameters
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
from_url | string | Original URL to be redirected. | Yes | /collections/hot-selling |
redirect_url | string | Target URL where the original URL will redirect users. | Yes | /collections/test1567 |
status | string | Status of the redirect: open (available) or close (unavailable). | Yes | open |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | Success | Response status |
data | string | Response message | |
data.count | int32 | 0 | The total number of redirects in the store. |
data.redirects | array[UrlRedirect] | The list of URL redirects. | |
data.redirects.id | string | 373043233132924740 | Unique identifier for the redirect. |
data.redirects.store_id | integer | 633130 | ID of the store where the redirect is created. |
data.redirects.status | string | open | Status of the redirect. |
data.redirects.from_url | string | /collections/hot-selling | The original URL specified for redirection. |
data.redirects.redirect_url | string | /collections/test1567 | The target URL specified for the redirection. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |