Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.

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/ 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/) 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

Tools

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.