For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
    • Closed Beta Programs
        • API Documentation
        • Check List
        • Code Samples
        • Guiding Questions
        • Iterative Feature Development
        • API Reference
Dev Portal
LogoLogo
On this page
  • Overview
  • Authentication
Closed Beta ProgramsPowered By

Powered by API

Beta
Was this page helpful?
Previous

Iterative Feature Development

Next

List Accounts

Built with
  • Overview
  • Authentication

Overview

Powered by is an API-focused product that enables partners to seamlessly provide the BigCommerce solution to their merchants alongside their own product offering. Through the use of our public APIs, partners can:

  • Manage the lifecycle of accounts and stores
  • Build a fully customizable onboarding flow that meets the needs of their own platform experience
  • Bill their merchants directly for BigCommerce services

Authentication

To authenticate, use the Generate an OAuth Token endpoint (in the Auth section below) to create an OAuth access token.


After you have a valid, unexpired OAuth token, use the client_id and oauth_token to authenticate all other API requests:

1GET https://api.bigcommerce.com/franchises/{franchise_uuid}/v1/accounts/123
2Accept: application/json
3X-Auth-Client: {client_id}
4X-Auth-Token: {oauth_token}

Response:

1{
2 "data": {
3 "id": "12345678910",
4 "name": "Test Company",
5 ...
6 },
7 "meta": {}
8}