sales
BigCommerce CLI for Coding Agents
Use the BigCommerce CLI for coding agents with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write Bearer token auth
BigCommerce CLI for Coding Agents
Let coding agents discover schemas and execute integration functions through CLI commands or MCP.
Use this pattern when another coding agent needs exact commands and schema discovery. The BigCommerce CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# BigCommerce CLI for Coding Agents
kosmokrator integrations:configure bigcommerce --set access_token="$BIGCOMMERCE_ACCESS_TOKEN" --enable --read allow --write ask --json
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 Discovery Before Execution
Agents and scripts can inspect BigCommerce docs and schemas 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 Useful BigCommerce CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
bigcommerce.bigcommerce_list_products | Read | limit, page, keyword, include, categories, is_visible, sort, direction | List products from the BigCommerce catalog. Supports pagination, filtering by name or SKU, and including variants/images. |
bigcommerce.bigcommerce_get_product | Read | id, include | Get a single product from the BigCommerce catalog by its ID. Returns full product details. |
bigcommerce.bigcommerce_create_product | Write | name, price, type, sku, description, weight, categories, brand_id, inventory_tracking, inventory_level, is_visible, custom_fields, images | Create a new product in the BigCommerce catalog. Requires name, price, and type (physical, digital, or giftcertificate). |
bigcommerce.bigcommerce_list_orders | Read | limit, page, status_id, customer_id, min_date_created, max_date_created, sort, direction | List orders from the BigCommerce store. Supports filtering by status, customer, and pagination. |
bigcommerce.bigcommerce_get_order | Read | id | Get a single order from the BigCommerce store by its ID. Returns full order details including line items and totals. |
bigcommerce.bigcommerce_list_customers | Read | limit, page, name, email, sort, direction | List customers from the BigCommerce store. Supports filtering by name or email and pagination. |
bigcommerce.bigcommerce_get_current_user | Read | none | Get the current user / storefront status from BigCommerce. Use this to verify the API connection is working. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.