BigCommerce

{/* 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_TOKEN is sent as the X-Auth-Token header.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
BIGCOMMERCE_ACCESS_TOKENYesBigCommerce store-level API account access token (sent as X-Auth-Token) Docs.
BIGCOMMERCE_STORE_HASHNoStore hash from the API path, e.g. the 'abc123' in https://api.bigcommerce.com/stores/abc123/v3/ Docs.

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.

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

Provider API reference.

Tools

ToolAccessDescription
List Orders<br /><code className="reference-identifier">bigcommerce__list_orders</code>ReadList orders
Get Order<br /><code className="reference-identifier">bigcommerce__get_order</code>ReadGet order
List Order Products<br /><code className="reference-identifier">bigcommerce__list_order_products</code>ReadList order products
Update Order<br /><code className="reference-identifier">bigcommerce__update_order</code>WriteUpdate order
List Products<br /><code className="reference-identifier">bigcommerce__list_products</code>ReadList products
Get Product<br /><code className="reference-identifier">bigcommerce__get_product</code>ReadGet product
List Customers<br /><code className="reference-identifier">bigcommerce__list_customers</code>ReadList customers
Create Product<br /><code className="reference-identifier">bigcommerce__create_product</code>WriteCreate product
Update Product<br /><code className="reference-identifier">bigcommerce__update_product</code>WriteUpdate product

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.