Redirects
Manage 301 redirects for one or more storefronts powered by a single BigCommerce backend. For a list of redirects that are not allowed, see the 301 Redirects FAQ (opens in a new tab) in our Help Center.
Get Redirects
GET https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirectsRequest
Returns a collection of the store's 301 redirects across all sites.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- site_id in query - integerFilters items by site ID.
- id:in in query - arrayFilters items by redirect ID. Also accepts comma-separated values to filter for multiple redirects.Type: array[integer]
- id:min in query - integerFilters items by minimum redirect ID.
- id:max in query - integerFilters items by maximum redirect ID.
- limit in query - integerControls the number of items to return per page.
- page in query - integerSpecifies the page number in a limited (paginated) list of items. Used to paginate large collections.
- sort in query - string
Field name to sort by. Since redirect IDs increment when new redirects are added, you can sort by ID to return results in redirect create date order.
Allowed: from_path | type | site_id | id
- direction in query - stringSort direction. Acceptable values are
asc
,desc
.Allowed: asc | desc
- include in query - arrayIndicates whether to include redirect sub-resources. Only
to_url
is supported.Type: array[string]Allowed: to_url
- keyword in query - stringFilters redirects by the specified keyword. Will only search from the beginning of a URL path. For example,
blue
will match/blue
and/blue-shirt
, not/royal-blue-shirt
.
example
Response
Body
object | application/json
dataarray[object]
example
Upsert Redirects
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirectsRequest
Upserts new redirect data across all storefronts.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
array | application/json
from_pathstring
requiredExample: /old-url/site_idinteger
requiredtoobject
example
Response
Created
Body
object | application/json
dataarray[object]
example
Delete Redirects
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/redirectsRequest
Deletes redirects.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- id:in in query - arrayrequiredA comma-separated list of redirect IDs to delete explicitly.Type: array[integer]
- site_id in query - integerTo delete all redirects for a given site, provide the site ID.
example
Response
No Content
See something you can improve? Edit this file on GitHub
Did you find what you were looking for?