Account-level APIs

Plan: Developer Foundations

Lesson 5 of 12 · 15 min

Introduction

Account-level APIs operate similarly to admin APIs but deal with data on the account level rather than the store level. A single BigCommerce account can be associated with multiple stores.

The GraphQL Account API is the only existing account-level API.

GraphQL Account API

The GraphQL Account API supports:

Authentication

The dashboard for creating account-level API accounts can be accessed from the BigCommerce control panel. When creating an account, you’ll specify the OAuth scopes the account has access to.

Creating an account-level API account

Like with store-level API accounts, each account is associated with a client ID, secret, and access token. The account UUID will be displayed as well.

Provide the OAuth access token in the X-Auth-Token header of GraphQL Account API requests.

Example Request:

POST https://api.bigcommerce.com/accounts/<account_uuid>/graphql
X-Auth-Token: <access_token>
Accept: application/json
Content-Type: application/json

Resources