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 Redirects API

The Redirects API from BigCommerce — 4 operation(s) for redirects.

BigCommerce Redirects 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 Redirects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 10 operations across 4 paths, and defines 7 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.

10 operations 4 paths 7 schemas 3 DELETE4 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 Redirects 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 10

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

Redirects 10
GET
/redirectsdeprecated
BigCommerce Get All Redirects
getRedirects 3 params → 200
POST
/redirects
BigCommerce Create a Redirect
createRedirect 2 params body → 200
DELETE
/redirectsdeprecated
BigCommerce Delete All Redirects
deleteRedirects 1 param → 204
GET
/redirects/{id}deprecated
BigCommerce Get a Redirect
getRedirect 2 params → 200
PUT
/redirects/{id}
BigCommerce Update a Redirect
updateRedirect 3 params body → 200
DELETE
/redirects/{id}
BigCommerce Delete a Redirect
deleteRedirect 2 params → 204
GET
/redirects/countdeprecated
BigCommerce Get a Count of Redirects
getRedirectsCount 1 param → 200
GET
/storefront/redirects
BigCommerce Get Redirects
getRedirects 9 params → 200
PUT
/storefront/redirects
BigCommerce Upsert Redirects
upsertRedirects 2 params body → 201
DELETE
/storefront/redirects
BigCommerce Delete Redirects
deleteRedirects 3 params → 204

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are 301RedirectRead (5 properties), redirect (4 properties), 301RedirectUpsert (3 properties), RedirectTo (3 properties). Each schema is shown below with its type and property counts.

RedirectTo
object
3 properties
count_Response
object
1 property
forward
object
2 properties
MetaPaginationObject
object
1 property
redirect
object
4 properties 2 required
301RedirectUpsert
object
Data necessary to create or update a redirect. If there’s a conflict on the frompath and siteid, the redirect will be overwritten with new data.
3 properties 2 required
301RedirectRead
object
Full detail of a Redirect, optionally including the full destination URL.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-redirects-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 Redirects 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.