At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key from
BIGCOMMERCE_ACCESS_TOKENis sent as theX-Auth-Tokenheader. - Docs: https://developer.bigcommerce.com/docs/start/authentication
Credentials
Set these per environment. See Connect an integration.| Variable | Required | Description |
|---|---|---|
BIGCOMMERCE_ACCESS_TOKEN | Yes | BigCommerce store-level API account access token (sent as X-Auth-Token) Docs. |
BIGCOMMERCE_STORE_HASH | Yes | Store hash from the API path, e.g. the ‘abc123’ in https://api.bigcommerce.com/stores/abc123/v3/ Docs. |
Setup
- Get a store (sandbox available): Use an existing BigCommerce store or create a free developer sandbox store at https://start.bigcommerce.com/developer-sandbox/ for testing.
- Create a store-level API account: In the store control panel go to Settings > API > Store-level API accounts and click Create API account. Choose Token type ‘V2/V3 API token’ and grant the OAuth scopes you need (e.g. Products: modify, Orders: read-only, Customers: read-only).
- Save the access token and store hash: After saving, BigCommerce shows the access token once (also downloaded as a .txt file). Set it as BIGCOMMERCE_ACCESS_TOKEN. The API path shown (https://api.bigcommerce.com/stores/{store_hash}/v3/) contains your store hash - set that as BIGCOMMERCE_STORE_HASH.
- Verify access: Run the List Products tool with your store hash to confirm the token works.
- The access token is shown only once at creation - store it securely
- Orders endpoints live on the v2 API; products and customers use v3
- Tools take a storeHash path parameter - pass the value of BIGCOMMERCE_STORE_HASH
Tools
| Tool | Access | Description |
|---|---|---|
| List Orders | Read | List store orders with optional status, customer, and date filtering (Orders are served by the v2 API) |
| Get Order | Read | Get full details of a single order (Orders are served by the v2 API) |
| List Order Products | Read | List the line items of an order - v2 order responses do not embed products, so use this to see what was bought |
| Update Order | Write | Update an order, e.g. change its status to Shipped/Cancelled/Refunded or add staff notes |
| List Products | Read | List catalog products with optional keyword, SKU, and availability filtering |
| Get Product | Read | Get full details of a single catalog product |
| List Customers | Read | List store customers with optional email and name filtering |
| Create Product | Write | Create a new product in the catalog |
| Update Product | Write | Update fields of an existing catalog product, such as price, visibility, or inventory |
Example prompts
- Show me the most recent orders in my BigCommerce store and summarize their statuses.
- List the products in my BigCommerce catalog and flag any that are hidden from the storefront.
- Find a BigCommerce customer by email and show their recent orders.