Get Url Redirect Details

Retrieve details of a specific url redirect using its unique identifier.

🔒

Requires read_shop_navigation access scope. More access scope

The Redirect Detail API allows users to retrieve details of a specific url redirect using its unique identifier.

Request Parameters

Public Request Parameters

📘

Path Parameters

ParameterTypeDescriptionRequiredExample
idstringUnique identifier for the redirect.Yes4540188244553

Response Explanation

Public Response Parameters

📘

Successful Response

FieldTypeExampleDescription
codestringSuccessResponse status
datastringResponse message
data.countint320The total number of redirects in the store.
data.redirectsarray[UrlRedirect]The list of URL redirects.
data.redirects.idstring373043233132924740Unique identifier for the redirect.
data.redirects.store_idinteger633130ID of the store where the redirect is created.
data.redirects.statusstringopenStatus of the redirect.
data.redirects.from_urlstring/collections/hot-sellingThe original URL specified for redirection.
data.redirects.redirect_urlstring/collections/test1567The target URL specified for the redirection.

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!