> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# BigCommerce

> Manage BigCommerce store data - products, orders, and customers via the Catalog, Orders, and Customers APIs

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `BIGCOMMERCE_ACCESS_TOKEN` is sent as the `X-Auth-Token` header.
* **Docs**: [https://developer.bigcommerce.com/docs/start/authentication](https://developer.bigcommerce.com/docs/start/authentication)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable                   | Required | Description                                                                                                                                                                                                                         |
| -------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BIGCOMMERCE_ACCESS_TOKEN` | Yes      | BigCommerce store-level API account access token (sent as X-Auth-Token) [Docs](https://developer.bigcommerce.com/docs/start/authentication/api-accounts).                                                                           |
| `BIGCOMMERCE_STORE_HASH`   | Yes      | Store hash from the API path, e.g. the 'abc123' in [https://api.bigcommerce.com/stores/abc123/v3/](https://api.bigcommerce.com/stores/abc123/v3/) [Docs](https://developer.bigcommerce.com/docs/start/authentication/api-accounts). |

## Setup

1. **Get a store (sandbox available)**: Use an existing BigCommerce store or create a free developer sandbox store at [https://start.bigcommerce.com/developer-sandbox/](https://start.bigcommerce.com/developer-sandbox/) for testing.
2. **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).
3. **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/](https://api.bigcommerce.com/stores/\{store_hash\}/v3/)) contains your store hash - set that as BIGCOMMERCE\_STORE\_HASH.
4. **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

Provider API reference: [https://developer.bigcommerce.com/docs/api](https://developer.bigcommerce.com/docs/api)

## 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.