Properties
| Name | Type | Description |
|---|---|---|
| type | string | The type of resource being routed to; [supported types](/docs/rest-management/sites#route-types). |
| matching | string | Depending on the resource type, this can be an ID (matching a specific item), or a "*" wildcard (matching all items of that type). For example, a route with a type: "product" and matching: "5" will be |
| route | string | The route template that will be used to generate the URL for the requested resource. Supports several tokens: - `{id}` The **ID** of the requested item. - `{slug}` The **slug** for the requested item |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/siteRoutes_Route_Base",
"title": "siteRoutes_Route_Base",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of resource being routed to; [supported types](/docs/rest-management/sites#route-types).",
"enum": [
"product",
"brand",
"category",
"page",
"blog",
"home",
"cart",
"checkout",
"search",
"account",
"login",
"returns",
"static"
]
},
"matching": {
"type": "string",
"example": "5",
"description": "Depending on the resource type, this can be an ID (matching a specific item), or a \"*\" wildcard (matching all items of that type).\n\nFor example, a route with a type: \"product\" and matching: \"5\" will be used for the product with the ID of 5."
},
"route": {
"type": "string",
"example": "/my-amazing-product",
"description": "The route template that will be used to generate the URL for the requested resource.\n\nSupports several tokens:\n- `{id}` The **ID** of the requested item.\n- `{slug}` The **slug** for the requested item (if available). Note: the `slug` value may contain `/` slash.\n- `{language}` The **language** string that the client is using."
}
},
"required": [
"type",
"matching",
"route"
],
"x-internal": false
}