> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to BigCommerce

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.

**Authentication:** API Key
**Categories:** Marketing, CRM & Sales
**Tools:** 26: 16 read, 8 write, 2 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BIGCOMMERCE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".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](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "bigcommerce"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize BigCommerce:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="bigcommerce_brands_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their BigCommerce credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'bigcommerce_brands_list',
  toolInput: {},
  connector: 'bigcommerce',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="bigcommerce_brands_list",
    tool_input={},
    connection_name="bigcommerce",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `bigcommerce_brands_list`

List Brands · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `name_like` (`string`, optional): Substring of the brand name. Example: acme
- `page` (`integer`, optional): Page number, starting at 1. Example: 2

Example input: `{}`

### `bigcommerce_catalog_summary_get`

Get Catalog Summary · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `bigcommerce_categories_list`

List Categories · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `is_visible` (`boolean`, optional): Only visible (true) or hidden (false) categories. Example: true
- `keyword` (`string`, optional): Search name and description. Example: summer
- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `name_like` (`string`, optional): Substring of the category name. Example: shirt
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `parent_id` (`integer`, optional): Only children of this category (0 for top level). Example: 0

Example input: `{}`

### `bigcommerce_customer_addresses_list`

List Customer Addresses · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id_in` (`string`, optional): Comma-separated customer IDs. Example: 11,12
- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `page` (`integer`, optional): Page number, starting at 1. Example: 2

Example input: `{}`

### `bigcommerce_customers_list`

List Customers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_in` (`string`, optional): Comma-separated company names. Example: Acme
- `date_modified_min` (`string`, optional): Modified on or after (e.g. 2026-11-01 or 2026-11-01T09:00:00). Example: 2026-11-01
- `email_in` (`string`, optional): Comma-separated emails. Example: jane@example.com
- `id_in` (`string`, optional): Comma-separated customer IDs. Example: 11,12
- `include` (`string`, optional): Sub-resources: addresses, storecredit, attributes, formfields, shopper_profile_id, segment_ids. Example: addresses
- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `name_like` (`string`, optional): Substring of first plus last name. Example: smith
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `sort` (`string`, optional): date_created:asc|desc, last_name:asc|desc or date_modified:asc|desc. Example: date_created:desc. One of: `date_created:asc`, `date_created:desc`, `last_name:asc`, `last_name:desc`, `date_modified:asc`, `date_modified:desc`.

Example input: `{}`

### `bigcommerce_order_get`

Get Order · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the order. Example: 100

Example input: `{"order_id":100}`

### `bigcommerce_order_products_list`

List Order Products · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the order. Example: 100
- `limit` (`integer`, optional): Results per page (default 50, maximum 250). Example: 50
- `page` (`integer`, optional): Page number, starting at 1. Example: 2

Example input: `{"order_id":100}`

### `bigcommerce_order_shipments_list`

List Order Shipments · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the order. Example: 100
- `limit` (`integer`, optional): Results per page (default 50, maximum 250). Example: 50
- `page` (`integer`, optional): Page number, starting at 1. Example: 2

Example input: `{"order_id":100}`

### `bigcommerce_order_shipping_addresses_list`

List Order Shipping Addresses · Read-only

List the shipping addresses of an order.
Returns an array of addresses with id, names, street, city, state, zip, country, email, phone and shipping_method.
Use bigcommerce_order_shipping_addresses_list to get the order_address_id for bigcommerce_order_shipment_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the order. Example: 100
- `limit` (`integer`, optional): Results per page (default 50, maximum 250). Example: 50
- `page` (`integer`, optional): Page number, starting at 1. Example: 2

Example input: `{"order_id":100}`

### `bigcommerce_order_statuses_list`

List Order Statuses · Read-only

List the order statuses with their IDs and the store's custom labels.
Returns an array of statuses with id, name, custom_label, system_label and order.
Use bigcommerce_order_statuses_list to map status IDs used by bigcommerce_orders_list and bigcommerce_order_update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `bigcommerce_orders_list`

List Orders · Read-only

List orders, filtered by customer, email, status, creation or modification date, ID range or total, sorted and paged.
Returns an array of orders with id, customer_id, status, status_id, date_created, total_inc_tax, items_total, payment_method and billing_address.
Use bigcommerce_orders_list to find orders. Use bigcommerce_order_get for one order, and bigcommerce_order_products_list for its line items.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`integer`, optional): Only orders by this customer. Example: 11
- `email` (`string`, optional): Only orders with this customer email. Example: jane@example.com
- `limit` (`integer`, optional): Results per page (default 50, maximum 250). Example: 50
- `max_date_created` (`string`, optional): Created on or before (ISO-8601 or RFC-2822). Example: 2026-11-15T23:59:59Z
- `max_id` (`integer`, optional): Maximum order ID. Example: 200
- `min_date_created` (`string`, optional): Created on or after (ISO-8601 or RFC-2822). Example: 2026-11-01T00:00:00Z
- `min_date_modified` (`string`, optional): Modified on or after (ISO-8601 or RFC-2822). Example: 2026-11-10T00:00:00Z
- `min_id` (`integer`, optional): Minimum order ID. Example: 100
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `sort` (`string`, optional): Field and direction, such as date_created:desc or id:asc. Example: date_created:desc
- `status_id` (`integer`, optional): Only orders in this status (see bigcommerce_order_statuses_list; 11 = Awaiting Fulfillment). Example: 11

Example input: `{}`

### `bigcommerce_product_get`

Get Product · Read-only

Get one catalog product, optionally with variants, images and other sub-resources.
Returns data with the product's fields and any embedded sub-resources.
Use bigcommerce_product_get when you know the product ID. Use bigcommerce_products_list to search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): ID of the product. Example: 174
- `include` (`string`, optional): Sub-resources to embed: variants, images, custom_fields, bulk_pricing_rules, primary_image, modifiers, options, videos. Example: variants,images
- `include_fields` (`string`, optional): Comma-separated fields to return (id is always returned). Example: name,sku,price,inventory_level

Example input: `{"product_id":174}`

### `bigcommerce_product_variants_list`

List Product Variants · Read-only

List the variants (option combinations such as size and color) of a product.
Returns data[] of variants with id, sku, price, sale_price, inventory_level, option_values and purchasing_disabled.
Use bigcommerce_product_variants_list to get variant IDs for bigcommerce_variant_update.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): ID of the product. Example: 174
- `include_fields` (`string`, optional): Comma-separated fields to return (id is always returned). Example: sku,price,inventory_level,option_values
- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `page` (`integer`, optional): Page number, starting at 1. Example: 2

Example input: `{"product_id":174}`

### `bigcommerce_products_list`

List Products · Read-only

List catalog products with filters for keyword, name, SKU, category, brand, visibility, stock and modification date, sorted and paged.
Returns data[] of products (id, name, sku, type, price, inventory_level, is_visible, categories, brand_id) and meta.pagination.
Use bigcommerce_products_list to search the catalog. Use bigcommerce_product_get for one product with its variants.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `brand_id` (`integer`, optional): Brand ID. Example: 36
- `categories_in` (`string`, optional): Comma-separated category IDs; products in any of them. Example: 23,24
- `date_modified_min` (`string`, optional): Modified on or after this date (ISO-8601). Example: 2026-11-01
- `direction` (`string`, optional): asc or desc. Example: desc. One of: `asc`, `desc`.
- `include` (`string`, optional): Sub-resources to embed: variants, images, custom_fields, bulk_pricing_rules, primary_image, modifiers, options, videos. Example: variants,primary_image
- `include_fields` (`string`, optional): Comma-separated fields to return (id is always returned). Example: name,sku,price,inventory_level,is_visible
- `inventory_low` (`integer`, optional): 1 for products at or below their low-stock warning level. Example: 1
- `is_visible` (`boolean`, optional): Only visible (true) or hidden (false) products. Example: true
- `keyword` (`string`, optional): Search name, description and SKU. Example: t-shirt
- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `name` (`string`, optional): Exact product name. Example: Classic T-Shirt
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `sku` (`string`, optional): Exact SKU. Example: SKU-TSHIRT-01
- `sort` (`string`, optional): Sort field: id, name, sku, price, date_modified, inventory_level, is_visible or total_sold. Example: date_modified. One of: `id`, `name`, `sku`, `price`, `date_modified`, `inventory_level`, `is_visible`, `total_sold`.

Example input: `{}`

### `bigcommerce_promotions_list`

List Promotions · Read-only

List promotions (automatic discounts and coupon promotions), filtered by name or code, status or redemption type.
Returns data[] of promotions with id, name, redemption_type, status, rules, start_date, end_date and current_uses.
Use bigcommerce_promotions_list to check active discounts and coupon codes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `direction` (`string`, optional): asc or desc. Example: desc. One of: `asc`, `desc`.
- `limit` (`integer`, optional): Items per page (default 50, maximum 250). Example: 50
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `query` (`string`, optional): Search promotion name or code. Example: SUMMER
- `redemption_type` (`string`, optional): automatic or coupon. Example: coupon. One of: `automatic`, `coupon`.
- `sort` (`string`, optional): id, name, priority or start_date. Example: start_date. One of: `id`, `name`, `priority`, `start_date`.
- `status` (`string`, optional): Promotion status, such as ENABLED, DISABLED or INVALID. Example: ENABLED

Example input: `{}`

### `bigcommerce_store_get`

Get Store Information · Read-only

Get the store's profile and settings.
Returns id, domain, secure_url, name, plan, status, currency, weight and dimension units, timezone and feature flags.
Use bigcommerce_store_get to check which store the connection is for and its currency and units.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `bigcommerce_category_create`

Create Category · Write

Create a catalog category.
Returns data with the new category, including id.
Use bigcommerce_category_create to add a category; use parent_id 0 for a top-level one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Category name, unique among its siblings. Example: Summer Collection
- `parent_id` (`integer`, required): Parent category ID; 0 for top level. Example: 0
- `description` (`string`, optional): Description; HTML allowed. Example: Light clothing for summer

- `is_visible` (`boolean`, optional): Show on the storefront. Example: true
- `sort_order` (`integer`, optional): Position in menus. Example: 1

Example input: `{"name":"<name>","parent_id":0}`

### `bigcommerce_customer_create`

Create Customer · Write

Create a customer account.
Returns data[] with the created customer, including id.
Use bigcommerce_customer_create to add a customer. Use bigcommerce_customers_list first to avoid a duplicate email.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Unique email. Example: jane@example.com
- `first_name` (`string`, required): First name. Example: Jane
- `last_name` (`string`, required): Last name. Example: Smith
- `addresses` (`array`, optional): Up to 10 addresses, each with first_name, last_name, address1, city, state_or_province, postal_code and country_code. Example: [{"first_name": "Jane", "last_name": "Smith", "address1": "1 Main St", "city": "Austin", "state_or_province": "Texas", "postal_code": "78701", "country_code": "US"}]
- `company` (`string`, optional): Company. Example: Acme Inc
- `customer_group_id` (`integer`, optional): Customer group ID. Example: 1
- `notes` (`string`, optional): Internal notes. Example: Wholesale lead
- `phone` (`string`, optional): Phone. Example: 555-0100

Example input: `{"email":"<email>","first_name":"<first_name>","last_name":"<last_name>"}`

### `bigcommerce_customer_update`

Update Customer · Write

Update a customer's email, name, company, phone, notes or group.
Returns data[] with the updated customer.
Use bigcommerce_customer_update to change customer details. Use bigcommerce_customers_list to find the ID.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`integer`, required): ID of the customer. Example: 11
- `company` (`string`, optional): New company. Example: Acme Corp
- `customer_group_id` (`integer`, optional): New customer group ID. Example: 2
- `email` (`string`, optional): New email. Example: jane.smith@example.com
- `first_name` (`string`, optional): New first name. Example: Jane
- `last_name` (`string`, optional): New last name. Example: Smith-Jones
- `notes` (`string`, optional): New internal notes. Example: VIP
- `phone` (`string`, optional): New phone. Example: 555-0101

Example input: `{"customer_id":11}`

### `bigcommerce_order_shipment_create`

Create Order Shipment · Write

Create a shipment for some or all items of an order, with tracking details; BigCommerce may email the customer.
Returns the shipment with id, tracking_number and items.
Use bigcommerce_order_shipment_create to fulfil an order. Get order_address_id from bigcommerce_order_shipping_addresses_list and item IDs from bigcommerce_order_products_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `items` (`array`, required): Items shipped, each {"order_product_id": ..., "quantity": ...}. Example: [{"order_product_id": 5, "quantity": 1}]
- `order_address_id` (`integer`, required): Shipping address ID of the order. Example: 1
- `order_id` (`integer`, required): ID of the order. Example: 100
- `comments` (`string`, optional): Shipment comments. Example: Shipped in two boxes
- `shipping_provider` (`string`, optional): auspost, canadapost, endicia, usps, fedex, ups, upsready, upsonline, shipperhq or royalmail (empty for custom). Example: ups
- `tracking_carrier` (`string`, optional): Tracking carrier code when shipping_provider is empty. Example: dhl
- `tracking_number` (`string`, optional): Carrier tracking number. Example: 1Z999AA10123456784

Example input: `{"items":[{"order_product_id":5,"quantity":1}],"order_address_id":1,"order_id":100}`

### `bigcommerce_order_update`

Update Order · Write

Update an order's status, staff notes, customer message or archived flag.
Returns the updated order.
Use bigcommerce_order_update to move an order to another status (get IDs from bigcommerce_order_statuses_list) or add staff notes.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_id` (`integer`, required): ID of the order. Example: 100
- `customer_message` (`string`, optional): Order comments shown to the customer. Example: Leave at the back door
- `is_deleted` (`boolean`, optional): true archives the order. Example: false
- `staff_notes` (`string`, optional): Notes for staff only. Example: Customer asked for gift wrap
- `status_id` (`integer`, optional): New status ID (see bigcommerce_order_statuses_list). Example: 2

Example input: `{"order_id":100}`

### `bigcommerce_product_create`

Create Product · Write

Create a catalog product.
Returns data with the new product, including id.
Use bigcommerce_product_create to add a product. Use bigcommerce_product_update to change one.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Unique product name. Example: Classic T-Shirt
- `price` (`number`, required): Base price. Example: 24.99
- `type` (`string`, required): physical or digital. Example: physical. One of: `physical`, `digital`.
- `weight` (`number`, required): Weight in the store's weight unit (use 0 for digital products). Example: 0.5
- `availability` (`string`, optional): available, disabled or preorder. Example: available. One of: `available`, `disabled`, `preorder`.
- `brand_id` (`integer`, optional): Brand ID. Example: 36
- `categories` (`array`, optional): Category IDs the product belongs to; replaces existing assignments. Example: [23, 24]
- `cost_price` (`number`, optional): Cost price, for reference only. Example: 8.5
- `description` (`string`, optional): Product description; HTML allowed. Example: Soft cotton t-shirt

- `inventory_level` (`integer`, optional): Stock level when inventory_tracking is product. Example: 100
- `inventory_tracking` (`string`, optional): none, product or variant. Example: product. One of: `none`, `product`, `variant`.
- `is_visible` (`boolean`, optional): Show the product on the storefront. Example: true
- `sale_price` (`number`, optional): Sale price used instead of price when set. Example: 19.99
- `sku` (`string`, optional): Unique SKU. Example: SKU-TSHIRT-01

Example input: `{"name":"<name>","price":24.99,"type":"physical","weight":0.5}`

### `bigcommerce_product_update`

Update Product · Write

Update a catalog product's name, price, stock, visibility, categories and other fields.
Returns data with the updated product.
Use bigcommerce_product_update to change a product. Use bigcommerce_variant_update for a single variant's price or stock.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): ID of the product. Example: 174
- `availability` (`string`, optional): available, disabled or preorder. Example: available. One of: `available`, `disabled`, `preorder`.
- `brand_id` (`integer`, optional): Brand ID. Example: 36
- `categories` (`array`, optional): Category IDs the product belongs to; replaces existing assignments. Example: [23, 24]
- `cost_price` (`number`, optional): Cost price, for reference only. Example: 8.5
- `description` (`string`, optional): Product description; HTML allowed. Example: Soft cotton t-shirt

- `inventory_level` (`integer`, optional): Stock level when inventory_tracking is product. Example: 100
- `inventory_tracking` (`string`, optional): none, product or variant. Example: product. One of: `none`, `product`, `variant`.
- `is_visible` (`boolean`, optional): Show the product on the storefront. Example: true
- `name` (`string`, optional): New name. Example: Classic T-Shirt (Organic)
- `price` (`number`, optional): New base price. Example: 26.99
- `sale_price` (`number`, optional): Sale price used instead of price when set. Example: 19.99
- `sku` (`string`, optional): Unique SKU. Example: SKU-TSHIRT-01
- `weight` (`number`, optional): New weight. Example: 0.6

Example input: `{"product_id":174}`

### `bigcommerce_variant_update`

Update Product Variant · Write

Update one variant's price, sale price, stock, SKU or purchasability.
Returns data with the updated variant.
Use bigcommerce_variant_update to change variant stock or price. Use bigcommerce_product_variants_list to find variant IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): ID of the product. Example: 174
- `variant_id` (`integer`, required): ID of the variant. Example: 382
- `inventory_level` (`integer`, optional): Stock level when inventory_tracking is variant. Example: 40
- `price` (`number`, optional): Variant price. Example: 24.99
- `purchasing_disabled` (`boolean`, optional): Stop shoppers buying this variant. Example: false
- `sale_price` (`number`, optional): Variant sale price. Example: 19.99
- `sku` (`string`, optional): New SKU. Example: SKU-TSHIRT-01-M

Example input: `{"product_id":174,"variant_id":382}`

### `bigcommerce_customer_delete`

Delete Customer · Destructive

Delete one or more customers.
Returns no content (HTTP 204) when deleted.
Use bigcommerce_customer_delete to remove customer accounts for good; confirm the IDs with bigcommerce_customers_list first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id_in` (`string`, required): Comma-separated IDs of the customers to delete. Example: 11

Example input: `{"id_in":"<id_in>"}`

### `bigcommerce_product_delete`

Delete Product · Destructive

Delete a catalog product and its variants.
Returns no content (HTTP 204) when deleted.
Use bigcommerce_product_delete to remove a product for good; set is_visible false with bigcommerce_product_update to hide it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `product_id` (`integer`, required): ID of the product. Example: 174

Example input: `{"product_id":174}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
