BigCommerce API Specifications

OpenAPI Specifications (OAS) and JSON schema used to generate the human-readable BigCommerce API Reference.

OAS updates

As of August 22, 2022, all API specification files are in OAS 3+ format. Please update your forks to ensure you're working with the newest source files.

Caveat: The file that contains webhook events callback schemas, webhooks_events.yml, is still in Swagger 2.0 format.

Directory structure

.
├── .circleci                          # config for circleci job that runs openapi linter
    └── config.yml                     # - docs: https://meta.stoplight.io/docs/spectral
├── docs                               # markdown files
├── models                             # yaml schema for various objects
    ├── ...
    └── json2schema.py                 # script to easily convert json data to yaml schema
├── reference                          # openapi specification files
├── .gitignore                         # gitignore
├── .spectral.yaml                     # config for stoplight spectral openapi linter
├── .stoplight.json                    # Stoplight Platform edit view configuration file
├── CONTRIBUTING.md                    # guidelines for contribution
├── pull_request_template_CODEOWNER.md # template for codeowner dev merges
├── pull_request_template.md           # template for most pull requests
└── toc.json                           # Stoplight Platform table of contents configuration file 

Contributing

If you're interested in contributing, see CONTRIBUTING.md.