Create Custom Route Settings

Creates a new custom route settings. Custom routing allows you to display SEO-friendly URLs on your site that map behind-the-scenes to resources such as a product page or a search results page. With custom routing, you gain advanced control over the URL structures on your site and can more visibly highlight the products or categories your shoppers are interested in purchasing.

POST /commerce/settings/general/customroutes

Error

A valid request URL is required to generate request examples

200

{
  "mappings": {},
  "routes": [
    {
      "canonical": true,
      "defaults": {},
      "functionId": "<string>",
      "internalRoute": "<string>",
      "mappings": {},
      "template": "<string>",
      "urlScheme": "<string>",
      "validators": {}
    }
  ],
  "validators": {}
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

mappings · object

Show child attributes

routes · object[] | null

Show child attributes

validators · object

Show child attributes

Response

200

application/json

Success

mappings · object

Show child attributes

routes · object[] | null

Show child attributes

validators · object

Show child attributes