Update Site’s Routes

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/sites/:site_id/routes

PUT

/stores/:store_hash/v3/sites/:site_id/routes

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/sites/1/routes \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {}
]'

{
  "data": [
    {
      "id": 123,
      "matching": "5",
      "route": "/my-amazing-product",
      "type": "brand"
    },
    {
      "id": 345,
      "matching": "5",
      "route": "/my-amazing-product",
      "type": "blog"
    },
    {
      "id": 234,
      "matching": "5",
      "route": "/my-amazing-product",
      "type": "returns"
    }
  ],
  "meta": {
    "pagination": {
      "total": 80,
      "count": 50,
      "per_page": 50,
      "current_page": 50,
      "links": {
        "next": "?page=2&limit=50",
        "current": "?page=1&limit=50"
      },
      "total_pages": 2
    }
  }
}

Upsert routes for site with ID {site_id}.

Usage Notes

id is required when updating an existing route.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

site_idintegerRequired

The ID of the site.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects a list of objects.

idintegerOptional

Unique ID for this route. Required when updating an existing route.

matchingstringOptional

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 used for the product with the ID of 5.

routestringOptional

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 (if available). Note: the slug value may contain / slash.
{language} The language string that the client is using.

typeenumOptional

The type of resource being routed to; supported types.

Response

datalist of objectsOptional

metaobjectOptional

Meta data relating to pagination.

Errors

422

Unprocessable Entity Error