Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to BigCommerce

Scalekit connector
Open markdown

The BigCommerce connector lets your AI agent act in each user's BigCommerce account. Each user connects their own BigCommerce API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 26 tools.

Tools
26
What they doRead · write · destructive
16 · 8 · 216 read8 write2 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the BigCommerce connection

    In AgentKit > Connections, create a BigCommerce connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'bigcommerce'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize BigCommerce:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'bigcommerce_brands_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their BigCommerce credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • bigcommerce_brands_listList catalog brands, filtered by name.Read-only

    List Brands

    List catalog brands, filtered by name. Returns data[] of brands with id, name, page_title, image_url and custom_url, plus meta.pagination. Use bigcommerce_brands_list to find a brand_id for products.

    Inputs

    limitinteger
    Items per page (default 50, maximum 250). Example: 50
    name_likestring
    Substring of the brand name. Example: acme
    pageinteger
    Page number, starting at 1. Example: 2
  • bigcommerce_catalog_summary_getGet catalog totals.Read-only

    Get Catalog Summary

    Get catalog totals. Returns data with inventory_count, inventory_value, primary_category, variant_count, highest_variant_price, average_variant_price and lowest_variant_price. Use bigcommerce_catalog_summary_get for a quick overview of the catalog.

    Inputs

    This tool takes no inputs.

  • bigcommerce_categories_listList catalog categories, filtered by name, parent or keyword.Read-only

    List Categories

    List catalog categories, filtered by name, parent or keyword. Returns data[] of categories with id, parent_id, name, is_visible, sort_order and custom_url, plus meta.pagination. Use bigcommerce_categories_list to get category IDs for products. Use bigcommerce_category_create to add one.

    Inputs

    is_visibleboolean
    Only visible (true) or hidden (false) categories. Example: true
    keywordstring
    Search name and description. Example: summer
    limitinteger
    Items per page (default 50, maximum 250). Example: 50
    name_likestring
    Substring of the category name. Example: shirt
    pageinteger
    Page number, starting at 1. Example: 2
    parent_idinteger
    Only children of this category (0 for top level). Example: 0
  • bigcommerce_customer_addresses_listList customer addresses, filtered by customer IDs, names or companies.Read-only

    List Customer Addresses

    List customer addresses, filtered by customer IDs, names or companies. Returns data[] of addresses with id, customer_id, names, address1, city, state_or_province, postal_code, country_code, phone and address_type. Use bigcommerce_customer_addresses_list to read a customer's saved addresses.

    Inputs

    customer_id_instring
    Comma-separated customer IDs. Example: 11,12
    limitinteger
    Items per page (default 50, maximum 250). Example: 50
    pageinteger
    Page number, starting at 1. Example: 2
  • bigcommerce_customers_listList customers, filtered by email, name, company, IDs or creation and modification dates.Read-only

    List Customers

    List customers, filtered by email, name, company, IDs or creation and modification dates. Returns data[] of customers (id, email, first_name, last_name, company, phone, customer_group_id, date_created) and meta.pagination. Use bigcommerce_customers_list to find a customer. Use bigcommerce_customer_addresses_list for their addresses.

    Inputs

    company_instring
    Comma-separated company names. Example: Acme
    date_modified_minstring
    Modified on or after (e.g. 2026-11-01 or 2026-11-01T09:00:00). Example: 2026-11-01
    email_instring
    Comma-separated emails. Example: jane@example.com
    id_instring
    Comma-separated customer IDs. Example: 11,12
    includestring
    Sub-resources: addresses, storecredit, attributes, formfields, shopper_profile_id, segment_ids. Example: addresses
    limitinteger
    Items per page (default 50, maximum 250). Example: 50
    name_likestring
    Substring of first plus last name. Example: smith
    pageinteger
    Page number, starting at 1. Example: 2
    sortstring
    date_created:asc|desc, last_name:asc|desc or date_modified:asc|desc. Example: date_created:descone of date_created:ascdate_created:desclast_name:asclast_name:descdate_modified:ascdate_modified:desc
  • bigcommerce_order_getGet one order.Read-only

    Get Order

    Get one order. Returns the order with status, dates, totals, taxes, discounts, payment method, billing_address, customer_message and staff_notes. Use bigcommerce_order_get for order details. Use bigcommerce_order_products_list for line items and bigcommerce_order_shipping_addresses_list for where it ships.

    Inputs

    order_idintegerrequired
    ID of the order. Example: 100
  • bigcommerce_order_products_listList the line items of an order.Read-only

    List Order Products

    List the line items of an order. Returns an array of order products with id, product_id, variant_id, name, sku, quantity, base_price, total_inc_tax and product_options. Use bigcommerce_order_products_list to see what was bought; the item IDs feed bigcommerce_order_shipment_create.

    Inputs

    order_idintegerrequired
    ID of the order. Example: 100
    limitinteger
    Results per page (default 50, maximum 250). Example: 50
    pageinteger
    Page number, starting at 1. Example: 2
  • bigcommerce_order_shipments_listList the shipments created for an order.Read-only

    List Order Shipments

    List the shipments created for an order. Returns an array of shipments with id, tracking_number, shipping_provider, tracking_carrier, items and date_created. Use bigcommerce_order_shipments_list to check fulfillment. Use bigcommerce_order_shipment_create to add one.

    Inputs

    order_idintegerrequired
    ID of the order. Example: 100
    limitinteger
    Results per page (default 50, maximum 250). Example: 50
    pageinteger
    Page number, starting at 1. Example: 2