Download OpenAPI Specifications

BigCommerce publishes downloadable OpenAPI specification files for its REST APIs. Import them into tools like Postman, generate client SDKs, or use them to explore and test endpoints as you build.

Browse the specifications

Because the docs include multiple API references, these endpoints return an index of the available specifications rather than a single file:

JSON: docs.bigcommerce.com/openapi.json
YAML: docs.bigcommerce.com/openapi.yml or docs.bigcommerce.com/openapi.yaml

Open one of these URLs to see an index of every available API. Each entry is a separate API reference; select one to view its OpenAPI specification in the browser. To save a copy, use your browser’s Save As option.

Download a specification directly

To pull a specification into your tools or keep it in sync, request it by name instead of using the index. The name is the last part of the link the index generates for each API. For example, the Catalog Products API resolves to admin-catalog-products:

Download with curl

# JSON
curl -O https://docs.bigcommerce.com/openapi/admin-catalog-products.json
# YAML
curl -O https://docs.bigcommerce.com/openapi/admin-catalog-products.yml
curl -O https://docs.bigcommerce.com/openapi/admin-catalog-products.yaml

Swap in the name of any API from the index, and use the .json, .yaml, or .yml extension for the format you want.

Where a resource has both a v2 and a v3 API, each version is listed separately in the index (for example, admin-management-customers-v2 and admin-management-customers-v3). Otherwise, the API version is reflected in the endpoint paths inside the specification, such as /stores/{store_hash}/v3/catalog/products.

For an overview of BigCommerce API families, see About Our APIs.