Create URL redirect

POST 
/openapi/2025-06/redirects

Create a new url redirect with the provided details.

Request

application/json

Body

Bodyrequired

redirect objectrequired

The URL redirect to be created

from_urlstringrequired

Original URL to be redirected

redirect_urlstringrequired

Target URL where the original URL will redirect users

statusstringrequired

Status of the redirect: open (available) or close (unavailable)

Example

{
  "redirect": {
    "from_url": "string",
    "redirect_url": "string",
    "status": "string"
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

redirect object

URL redirect

idint64

Redirect ID

store_idint32

ID of the store where the redirect is created

statusstring

Status of the redirect

from_urlstring

The original URL specified for redirection

redirect_urlstring

The target URL specified for the redirection

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "redirect": {
      "id": 0,
      "store_id": 0,
      "status": "string",
      "from_url": "string",
      "redirect_url": "string"
    }
  }
}