BigCommerce API Specifications

This repo contains the OpenAPI Specifications (OAS) and JSON schema that form the human-readable BigCommerce REST API Reference.

As of August 22, 2022, all API specification files are in OAS 3+ format. We also made significant changes to this repo in March 2023. Please update your fork to ensure you're working with the newest source files.

Contributing

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

Directory structure

.
├── .github/                           # github config
    └── workflows/                     # workflows to lint pull requests, etc.
├── .idea/                             # directory ignored by git - use for yourself
├── models/                            # yml schema for various objects
    ├── email_templates/               # email template schemas
    ├── webhooks/                      # webhooks schemas
    └── json2schema.py                 # script to convert json to yml
├── reference/                         # openapi specification files
    ├── catalog/                       # catalog OAS API reference
    ├── payments/                      # payments OAS API reference
    └── ...                            # other OAS API reference
├── .eslintrc.json                     # config for MDX linter
├── .gitignore                         # gitignore
├── .spectral.yaml                     # config for OAS linter
├── CONTRIBUTING                       # guidelines for contribution
├── package-lock.json
├── package.json
├── pull_request_template.md           # template for most pull requests         
└── README