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 Import-Export API

The Import-Export API from BigCommerce — 6 operation(s) for import-export.

BigCommerce Import-Export 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 Import Export. 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 6 paths, and defines 5 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 6 paths 5 schemas 4 GET2 POST

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 Import-Export 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 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Import-Export 6
GET
/storefront/redirects/imex/jobs
BigCommerce Get Redirect Import-Export Jobs
getRedirectImportExportJobs 6 params → 200
POST
/storefront/redirects/imex/export
BigCommerce Create Redirects Export Job
createRedirectExportJob 2 params body → 201409429
POST
/storefront/redirects/imex/import
BigCommerce Create Redirects Import Job
createRedirectImportJob 2 params body → 201400413429
GET
/storefront/redirects/imex/export/{uuid}/events
BigCommerce Open Redirect Export Event Stream
getRedirectExportEvents 2 params → 200404
GET
/storefront/redirects/imex/import/{uuid}/events
BigCommerce Open Redirect Import Event Stream
getRedirectImportEvents 2 params → 200404
GET
/storefront/redirects/imex/export/{uuid}/download
BigCommerce Download Redirect Export
getRedirectExportDownload 2 params → 200404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are 301RedirectImportExportJobRead (9 properties), MetaPaginationObject (1 property). Each schema is shown below with its type and property counts.

301RedirectImportExportJobRead
object
Full detail of a Redirect Import-Export job.
9 properties
ImportExportJobStatus
string
ImportExportJobType
string
MetaPaginationObject
object
1 property
ImportErrors
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-import-export-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 Import-Export 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.