{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}
At a glance
- Availability: Experimental (how to enable).
- Authentication: API key.
- Connection: The key from
BIGCOMMERCE_ACCESS_TOKENis sent as theX-Auth-Tokenheader. - Provider documentation: Authentication reference.
Credentials
Set these per environment. See Connect an integration.
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.
Provider notes
- 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
Verify the connection
Call a read tool such as bigcommerce__list_orders with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.