Create Redirect

POST 
/openapi/2022-01/redirects

Create a new url redirect with the provided details.

Request

application/json

Body

Body

from_urlstringrequired

Original URL, for example: /collections/hot-selling

redirect_urlstringrequired

Redirected URL, for example: /collections/test1567

statusstringrequired
The status of the redirect:
- open: available
- close: unavailable
Default value: open

Example

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

Responses

200

200

application/json

Schema

Schema

idinteger
Default value: 0
Example: 373043233132924740
store_idinteger
Default value: 0
Example: 633130
statusstring
Example: open
from_urlstring
Example: /collections/hot-selling
redirect_urlstring
Example: /collections/test1567

Example

{
  "id": 373043233132924740,
  "store_id": 633130,
  "status": "open",
  "from_url": "/collections/hot-selling",
  "redirect_url": "/collections/test1567"
}

Result

{
  "id": 373043233132924740,
  "store_id": 633130,
  "status": "open",
  "from_url": "/collections/hot-selling",
  "redirect_url": "/collections/test1567"
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Path has already been take"
  ]
}

Result

{
  "errors": [
    "Path has already been take"
  ]
}