Can I use BigCommerce as a CLI?

Yes. KosmoKrator exposes a BigCommerce CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose BigCommerce through MCP?

Yes. The KosmoKrator MCP gateway can expose selected BigCommerce tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are BigCommerce credentials stored?

BigCommerce credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for BigCommerce MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

sales

BigCommerce CLI for AI Agents

Use the BigCommerce CLI from KosmoKrator to call BigCommerce tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

7 functions 6 read 1 write Bearer token auth

Submit BigCommerce feedback View package source

BigCommerce CLI Setup

BigCommerce can be configured headlessly with `kosmokrator integrations:configure bigcommerce`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure bigcommerce --set access_token="$BIGCOMMERCE_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor bigcommerce --json
kosmokrator integrations:status --json

Credentials

Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

Key	Env var	Type	Required	Label
`access_token`	`BIGCOMMERCE_ACCESS_TOKEN`	Secret `secret`	yes	Access Token
`base_url`	`BIGCOMMERCE_BASE_URL`	URL `url`	no	Base URL

Call BigCommerce Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call bigcommerce.bigcommerce_list_products '{
  "limit": 1,
  "page": 1,
  "keyword": "example_keyword",
  "include": "example_include",
  "categories": "example_categories",
  "is_visible": true,
  "sort": "example_sort",
  "direction": "example_direction"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:bigcommerce bigcommerce_list_products '{
  "limit": 1,
  "page": 1,
  "keyword": "example_keyword",
  "include": "example_include",
  "categories": "example_categories",
  "is_visible": true,
  "sort": "example_sort",
  "direction": "example_direction"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs bigcommerce --json
kosmo integrations:docs bigcommerce.bigcommerce_list_products --json
kosmo integrations:schema bigcommerce.bigcommerce_list_products --json
kosmo integrations:search "BigCommerce" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to BigCommerce.

`bigcommerce.bigcommerce_list_products`

Read read

List products from the BigCommerce catalog. Supports pagination, filtering by name or SKU, and including variants/images.

Parameters: limit, page, keyword, include, categories, is_visible, sort, direction

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_list_products '{"limit":1,"page":1,"keyword":"example_keyword","include":"example_include","categories":"example_categories","is_visible":true,"sort":"example_sort","direction":"example_direction"}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_list_products '{"limit":1,"page":1,"keyword":"example_keyword","include":"example_include","categories":"example_categories","is_visible":true,"sort":"example_sort","direction":"example_direction"}' --json

`bigcommerce.bigcommerce_get_product`

Read read

Get a single product from the BigCommerce catalog by its ID. Returns full product details.

Parameters: id, include

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_get_product '{"id":1,"include":"example_include"}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_get_product '{"id":1,"include":"example_include"}' --json

`bigcommerce.bigcommerce_create_product`

Write write

Create a new product in the BigCommerce catalog. Requires name, price, and type (physical, digital, or giftcertificate).

Parameters: name, price, type, sku, description, weight, categories, brand_id, inventory_tracking, inventory_level, is_visible, custom_fields, images

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_create_product '{"name":"example_name","price":1,"type":"example_type","sku":"example_sku","description":"example_description","weight":1,"categories":"example_categories","brand_id":1}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_create_product '{"name":"example_name","price":1,"type":"example_type","sku":"example_sku","description":"example_description","weight":1,"categories":"example_categories","brand_id":1}' --json

`bigcommerce.bigcommerce_list_orders`

Read read

List orders from the BigCommerce store. Supports filtering by status, customer, and pagination.

Parameters: limit, page, status_id, customer_id, min_date_created, max_date_created, sort, direction

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_list_orders '{"limit":1,"page":1,"status_id":1,"customer_id":1,"min_date_created":"example_min_date_created","max_date_created":"example_max_date_created","sort":"example_sort","direction":"example_direction"}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_list_orders '{"limit":1,"page":1,"status_id":1,"customer_id":1,"min_date_created":"example_min_date_created","max_date_created":"example_max_date_created","sort":"example_sort","direction":"example_direction"}' --json

`bigcommerce.bigcommerce_get_order`

Read read

Get a single order from the BigCommerce store by its ID. Returns full order details including line items and totals.

Parameters: id

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_get_order '{"id":1}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_get_order '{"id":1}' --json

`bigcommerce.bigcommerce_list_customers`

Read read

List customers from the BigCommerce store. Supports filtering by name or email and pagination.

Parameters: limit, page, name, email, sort, direction

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_list_customers '{"limit":1,"page":1,"name":"example_name","email":"example_email","sort":"example_sort","direction":"example_direction"}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_list_customers '{"limit":1,"page":1,"name":"example_name","email":"example_email","sort":"example_sort","direction":"example_direction"}' --json

`bigcommerce.bigcommerce_get_current_user`

Read read

Get the current user / storefront status from BigCommerce. Use this to verify the API connection is working.

Parameters: none

Generic CLI call

kosmo integrations:call bigcommerce.bigcommerce_get_current_user '{}' --json

Provider shortcut

kosmo integrations:bigcommerce bigcommerce_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

`bigcommerce.bigcommerce_list_products`

List products from the BigCommerce catalog. Supports pagination, filtering by name or SKU, and including variants/images.

Operation: Read read
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_list_products --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of products to return per page (default: 50, max: 250).
`page`	integer	no	Page number for pagination (default: 1).
`keyword`	string	no	Filter products by keyword (matches name or SKU).
`include`	string	no	Comma-separated related resources to include (e.g., "variants,images,custom_fields").
`categories`	string	no	Comma-separated category IDs to filter by.
`is_visible`	boolean	no	Filter by visibility (true for visible, false for hidden).
`sort`	string	no	Sort field (e.g., "name", "price", "date_created", "id").
`direction`	string	no	Sort direction: "asc" or "desc".

`bigcommerce.bigcommerce_get_product`

Get a single product from the BigCommerce catalog by its ID. Returns full product details.

Operation: Read read
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_get_product --json

Parameter	Type	Required	Description
`id`	integer	yes	The product ID.
`include`	string	no	Comma-separated related resources to include (e.g., "variants,images,custom_fields,bulk_pricing_rules").

`bigcommerce.bigcommerce_create_product`

Create a new product in the BigCommerce catalog. Requires name, price, and type (physical, digital, or giftcertificate).

Operation: Write write
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_create_product --json

Parameter	Type	Required	Description
`name`	string	yes	Product name.
`price`	number	yes	Base price (e.g., 29.99). Use 0 for free products.
`type`	string	yes	Product type: "physical", "digital", or "giftcertificate".
`sku`	string	no	Unique SKU for the product.
`description`	string	no	Product description (HTML allowed).
`weight`	number	no	Weight of the product (required for physical products).
`categories`	array	no	Array of category IDs to assign the product to.
`brand_id`	integer	no	The brand ID to assign.
`inventory_tracking`	string	no	Inventory tracking: "none", "product", or "variant".
`inventory_level`	integer	no	Current stock level (when inventory_tracking is "product").
`is_visible`	boolean	no	Whether the product is visible on the storefront (default: true).
`custom_fields`	array	no	Array of custom field objects with "name" and "value" keys.
`images`	array	no	Array of image objects with "image_url" key.

`bigcommerce.bigcommerce_list_orders`

List orders from the BigCommerce store. Supports filtering by status, customer, and pagination.

Operation: Read read
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_list_orders --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of orders per page (default: 50, max: 250).
`page`	integer	no	Page number for pagination (default: 1).
`status_id`	integer	no	Filter by order status ID (0=Awaiting Fulfillment, 1=Awaiting Shipment, 2=Shipped, 3=Completed, 4=Cancelled, etc.).
`customer_id`	integer	no	Filter by customer ID.
`min_date_created`	string	no	Minimum date created (ISO 8601, e.g., "2025-01-01").
`max_date_created`	string	no	Maximum date created (ISO 8601, e.g., "2025-12-31").
`sort`	string	no	Sort field (e.g., "date_created", "total_inc_tax", "id").
`direction`	string	no	Sort direction: "asc" or "desc".

`bigcommerce.bigcommerce_get_order`

Get a single order from the BigCommerce store by its ID. Returns full order details including line items and totals.

Operation: Read read
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_get_order --json

Parameter	Type	Required	Description
`id`	integer	yes	The order ID.

`bigcommerce.bigcommerce_list_customers`

List customers from the BigCommerce store. Supports filtering by name or email and pagination.

Operation: Read read
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_list_customers --json

Parameter	Type	Required	Description
`limit`	integer	no	Number of customers per page (default: 50, max: 250).
`page`	integer	no	Page number for pagination (default: 1).
`name`	string	no	Filter by customer name.
`email`	string	no	Filter by email address.
`sort`	string	no	Sort field (e.g., "name", "email", "date_created", "id").
`direction`	string	no	Sort direction: "asc" or "desc".

`bigcommerce.bigcommerce_get_current_user`

Get the current user / storefront status from BigCommerce. Use this to verify the API connection is working.

Operation: Read read
Schema command: kosmo integrations:schema bigcommerce.bigcommerce_get_current_user --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.