Search Url Redirect

🔒

Requires write_shop_navigation access 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:

  1. Removing outdated or invalid redirects.
  2. Cleaning up unused or deprecated redirect entries.
  3. Maintaining a streamlined list of active redirects.

Request Parameters

Public Request Parameters

📘

ParameterTypeRequiredDescriptionExample
idstringYesUnique identifier of the redirect.4540188244553

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!