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
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the BigCommerce connection
In AgentKit > Connections, create a BigCommerce connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'bigcommerce'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'bigcommerce_brands_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "bigcommerce"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="bigcommerce_brands_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolbigcommerce_brands_listList catalog brands, filtered by name.Read-onlyList 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-onlyGet 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-onlyList 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-onlyList 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-onlyList 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-onlyGet 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-onlyList 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-onlyList 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
bigcommerce_order_shipping_addresses_listList the shipping addresses of an order.Read-onlyList Order Shipping Addresses
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.
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_statuses_listList the order statuses with their IDs and the store's custom labels.Read-onlyList Order Statuses
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.
Inputs
This tool takes no inputs.
bigcommerce_orders_listList orders, filtered by customer, email, status, creation or modification date, ID range or total, sorted and paged.Read-onlyList Orders
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.
Inputs
customer_idinteger- Only orders by this customer. Example: 11
emailstring- Only orders with this customer email. Example: jane@example.com
limitinteger- Results per page (default 50, maximum 250). Example: 50
max_date_createdstring- Created on or before (ISO-8601 or RFC-2822). Example: 2026-11-15T23:59:59Z
max_idinteger- Maximum order ID. Example: 200
min_date_createdstring- Created on or after (ISO-8601 or RFC-2822). Example: 2026-11-01T00:00:00Z
min_date_modifiedstring- Modified on or after (ISO-8601 or RFC-2822). Example: 2026-11-10T00:00:00Z
min_idinteger- Minimum order ID. Example: 100
pageinteger- Page number, starting at 1. Example: 2
sortstring- Field and direction, such as date_created:desc or id:asc. Example: date_created:desc
status_idinteger- Only orders in this status (see bigcommerce_order_statuses_list; 11 = Awaiting Fulfillment). Example: 11
bigcommerce_product_getGet one catalog product, optionally with variants, images and other sub-resources.Read-onlyGet Product
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.
Inputs
product_idintegerrequired- ID of the product. Example: 174
includestring- Sub-resources to embed: variants, images, custom_fields, bulk_pricing_rules, primary_image, modifiers, options, videos. Example: variants,images
include_fieldsstring- Comma-separated fields to return (id is always returned). Example: name,sku,price,inventory_level
bigcommerce_product_variants_listList the variants (option combinations such as size and color) of a product.Read-onlyList Product Variants
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.
Inputs
product_idintegerrequired- ID of the product. Example: 174
include_fieldsstring- Comma-separated fields to return (id is always returned). Example: sku,price,inventory_level,option_values
limitinteger- Items per page (default 50, maximum 250). Example: 50
pageinteger- Page number, starting at 1. Example: 2
bigcommerce_products_listList catalog products with filters for keyword, name, SKU, category, brand, visibility, stock and modification date, sorted and paged.Read-onlyList Products
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.
Inputs
brand_idinteger- Brand ID. Example: 36
categories_instring- Comma-separated category IDs; products in any of them. Example: 23,24
date_modified_minstring- Modified on or after this date (ISO-8601). Example: 2026-11-01
directionstring- asc or desc. Example: descone of
ascdesc includestring- Sub-resources to embed: variants, images, custom_fields, bulk_pricing_rules, primary_image, modifiers, options, videos. Example: variants,primary_image
include_fieldsstring- Comma-separated fields to return (id is always returned). Example: name,sku,price,inventory_level,is_visible
inventory_lowinteger- 1 for products at or below their low-stock warning level. Example: 1
is_visibleboolean- Only visible (true) or hidden (false) products. Example: true
keywordstring- Search name, description and SKU. Example: t-shirt
limitinteger- Items per page (default 50, maximum 250). Example: 50
namestring- Exact product name. Example: Classic T-Shirt
pageinteger- Page number, starting at 1. Example: 2
skustring- Exact SKU. Example: SKU-TSHIRT-01
sortstring- Sort field: id, name, sku, price, date_modified, inventory_level, is_visible or total_sold. Example: date_modifiedone of
idnameskupricedate_modifiedinventory_levelis_visibletotal_sold
bigcommerce_promotions_listList promotions (automatic discounts and coupon promotions), filtered by name or code, status or redemption type.Read-onlyList Promotions
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.
Inputs
directionstring- asc or desc. Example: descone of
ascdesc limitinteger- Items per page (default 50, maximum 250). Example: 50
pageinteger- Page number, starting at 1. Example: 2
querystring- Search promotion name or code. Example: SUMMER
redemption_typestring- automatic or coupon. Example: couponone of
automaticcoupon sortstring- id, name, priority or start_date. Example: start_dateone of
idnameprioritystart_date statusstring- Promotion status, such as ENABLED, DISABLED or INVALID. Example: ENABLED
bigcommerce_store_getGet the store's profile and settings.Read-onlyGet Store Information
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.
Inputs
This tool takes no inputs.
bigcommerce_category_createCreate a catalog category.WriteCreate Category
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.
Inputs
namestringrequired- Category name, unique among its siblings. Example: Summer Collection
parent_idintegerrequired- Parent category ID; 0 for top level. Example: 0
descriptionstring- Description; HTML allowed. Example: <p>Light clothing for summer</p>
is_visibleboolean- Show on the storefront. Example: true
sort_orderinteger- Position in menus. Example: 1
bigcommerce_customer_createCreate a customer account.WriteCreate Customer
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.
Inputs
emailstringrequired- Unique email. Example: jane@example.com
first_namestringrequired- First name. Example: Jane
last_namestringrequired- Last name. Example: Smith
addressesarray- 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"}]
companystring- Company. Example: Acme Inc
customer_group_idinteger- Customer group ID. Example: 1
notesstring- Internal notes. Example: Wholesale lead
phonestring- Phone. Example: 555-0100
bigcommerce_customer_updateUpdate a customer's email, name, company, phone, notes or group.WriteUpdate Customer
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.
- Idempotent
Inputs
customer_idintegerrequired- ID of the customer. Example: 11
companystring- New company. Example: Acme Corp
customer_group_idinteger- New customer group ID. Example: 2
emailstring- New email. Example: jane.smith@example.com
first_namestring- New first name. Example: Jane
last_namestring- New last name. Example: Smith-Jones
notesstring- New internal notes. Example: VIP
phonestring- New phone. Example: 555-0101
bigcommerce_order_shipment_createCreate a shipment for some or all items of an order, with tracking details; BigCommerce may email the customer.WriteCreate Order Shipment
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.
Inputs
itemsarrayrequired- Items shipped, each {"order_product_id": ..., "quantity": ...}. Example: [{"order_product_id": 5, "quantity": 1}]
order_address_idintegerrequired- Shipping address ID of the order. Example: 1
order_idintegerrequired- ID of the order. Example: 100
commentsstring- Shipment comments. Example: Shipped in two boxes
shipping_providerstring- auspost, canadapost, endicia, usps, fedex, ups, upsready, upsonline, shipperhq or royalmail (empty for custom). Example: ups
tracking_carrierstring- Tracking carrier code when shipping_provider is empty. Example: dhl
tracking_numberstring- Carrier tracking number. Example: 1Z999AA10123456784
bigcommerce_order_updateUpdate an order's status, staff notes, customer message or archived flag.WriteUpdate Order
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.
- Idempotent
Inputs
order_idintegerrequired- ID of the order. Example: 100
customer_messagestring- Order comments shown to the customer. Example: Leave at the back door
is_deletedboolean- true archives the order. Example: false
staff_notesstring- Notes for staff only. Example: Customer asked for gift wrap
status_idinteger- New status ID (see bigcommerce_order_statuses_list). Example: 2
bigcommerce_product_createCreate a catalog product.WriteCreate Product
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.
Inputs
namestringrequired- Unique product name. Example: Classic T-Shirt
pricenumberrequired- Base price. Example: 24.99
typestringrequired- physical or digital. Example: physicalone of
physicaldigital weightnumberrequired- Weight in the store's weight unit (use 0 for digital products). Example: 0.5
availabilitystring- available, disabled or preorder. Example: availableone of
availabledisabledpreorder brand_idinteger- Brand ID. Example: 36
categoriesarray- Category IDs the product belongs to; replaces existing assignments. Example: [23, 24]
cost_pricenumber- Cost price, for reference only. Example: 8.5
descriptionstring- Product description; HTML allowed. Example: <p>Soft cotton t-shirt</p>
inventory_levelinteger- Stock level when inventory_tracking is product. Example: 100
inventory_trackingstring- none, product or variant. Example: productone of
noneproductvariant is_visibleboolean- Show the product on the storefront. Example: true
sale_pricenumber- Sale price used instead of price when set. Example: 19.99
skustring- Unique SKU. Example: SKU-TSHIRT-01
bigcommerce_product_updateUpdate a catalog product's name, price, stock, visibility, categories and other fields.WriteUpdate Product
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.
- Idempotent
Inputs
product_idintegerrequired- ID of the product. Example: 174
availabilitystring- available, disabled or preorder. Example: availableone of
availabledisabledpreorder brand_idinteger- Brand ID. Example: 36
categoriesarray- Category IDs the product belongs to; replaces existing assignments. Example: [23, 24]
cost_pricenumber- Cost price, for reference only. Example: 8.5
descriptionstring- Product description; HTML allowed. Example: <p>Soft cotton t-shirt</p>
inventory_levelinteger- Stock level when inventory_tracking is product. Example: 100
inventory_trackingstring- none, product or variant. Example: productone of
noneproductvariant is_visibleboolean- Show the product on the storefront. Example: true
namestring- New name. Example: Classic T-Shirt (Organic)
pricenumber- New base price. Example: 26.99
sale_pricenumber- Sale price used instead of price when set. Example: 19.99
skustring- Unique SKU. Example: SKU-TSHIRT-01
weightnumber- New weight. Example: 0.6
bigcommerce_variant_updateUpdate one variant's price, sale price, stock, SKU or purchasability.WriteUpdate Product Variant
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.
- Idempotent
Inputs
product_idintegerrequired- ID of the product. Example: 174
variant_idintegerrequired- ID of the variant. Example: 382
inventory_levelinteger- Stock level when inventory_tracking is variant. Example: 40
pricenumber- Variant price. Example: 24.99
purchasing_disabledboolean- Stop shoppers buying this variant. Example: false
sale_pricenumber- Variant sale price. Example: 19.99
skustring- New SKU. Example: SKU-TSHIRT-01-M
bigcommerce_customer_deleteDelete one or more customers.DestructiveDelete Customer
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.
- Idempotent
Inputs
id_instringrequired- Comma-separated IDs of the customers to delete. Example: 11
bigcommerce_product_deleteDelete a catalog product and its variants.DestructiveDelete Product
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.
- Idempotent
Inputs
product_idintegerrequired- ID of the product. Example: 174
No tools match.