post https://{shopdomain}.myshoplaza.com/openapi/2022-01/redirects/detail
Requires
read_shop_navigationaccess scope. More access scope
The Search Redirect API retrieves details of a specific redirect based on the original URL (from_url).
This API is especially useful for:
- Validating the existence of a specific redirect in the store.
- Retrieving the redirection target for a specific URL.
- Debugging or verifying the status of individual redirects.
Request Parameters
Public Request Parameters
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
from_url | string | Yes | The original URL to search for a redirect. | /collections/hot-selling |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
id | string | Unique identifier for the redirect. | 373043233132924740 |
store_id | integer | ID of the store where the redirect is configured. | 633130 |
status | string | Status of the redirect. | open |
from_url | string | The original URL specified for redirection. | /collections/hot-selling |
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 |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "Record not found" | 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 from_url is not existed. | "Record not found" |