How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BigCommerce Site Routes API

The Site Routes API from BigCommerce — 2 operation(s) for site routes.

BigCommerce Site Routes API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Site Routes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 6 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

6 operations 2 paths 8 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Site Routes API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Site Routes 6
GET
/sites/{site_id}/routes
BigCommerce Get a Site’s Routes
getSiteRoutes 5 params → 200
POST
/sites/{site_id}/routes
BigCommerce Create a Site Route
createSiteRoute 3 params body → 201422502
PUT
/sites/{site_id}/routes
BigCommerce Update a Site’s Routes
updateSiteRoutes 3 params body → 200422
GET
/sites/{site_id}/routes/{route_id}
BigCommerce Get a Site Route
getSiteRoute 3 params → 200
PUT
/sites/{site_id}/routes/{route_id}
BigCommerce Update a Site Route
updateSiteRoute 4 params body → 201
DELETE
/sites/{site_id}/routes/{route_id}
BigCommerce Delete a Site Route
deleteSiteRoute 3 params → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are siteRoute_Base (3 properties), error_Full (3 properties), siteRoutes_Route_Base (3 properties), _metaCollection (1 property). Each schema is shown below with its type and property counts.

siteRoute_Full
Route object used in responses.
_metaCollection
object
Meta data relating to pagination.
1 property
_errors
object
The keys and values in an errors object will vary depending on the error received.
siteRoute_Base
object
3 properties
MetaOpen
object
Response metadata.
_metaEmpty
object
Empty meta object; may be used later.
siteRoutes_Route_Base
object
3 properties 3 required
error_Full
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-site-routes-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Site Routes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.