productivity
BigCommerce MCP, CLI, and Lua Integration for AI Agents
BigCommerce integration docs for AI agents: MCP gateway setup, BigCommerce CLI commands, Lua API reference, credentials, and function schemas.BigCommerce for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
bigcommerce.bigcommerce_list_products | Read read | 0 | List catalog products with BigCommerce v3 filters. |
bigcommerce.bigcommerce_get_product | Read read | 0 | Get one catalog product by ID. |
bigcommerce.bigcommerce_create_product | Write write | 0 | Create a catalog product. |
bigcommerce.bigcommerce_update_product | Write write | 0 | Update a catalog product. |
bigcommerce.bigcommerce_delete_product | Write write | 0 | Delete a catalog product. |
bigcommerce.bigcommerce_list_product_variants | Read read | 0 | List variants for a catalog product. |
bigcommerce.bigcommerce_get_product_variant | Read read | 0 | Get one product Variant. |
bigcommerce.bigcommerce_create_product_variant | Write write | 0 | Create a product Variant. |
bigcommerce.bigcommerce_update_product_variant | Write write | 0 | Update a product Variant. |
bigcommerce.bigcommerce_delete_product_variant | Write write | 0 | Delete a product Variant. |
bigcommerce.bigcommerce_list_product_images | Read read | 0 | List images for a catalog product. |
bigcommerce.bigcommerce_get_product_image | Read read | 0 | Get one product Image. |
bigcommerce.bigcommerce_create_product_image | Write write | 0 | Create a product Image. |
bigcommerce.bigcommerce_update_product_image | Write write | 0 | Update a product Image. |
bigcommerce.bigcommerce_delete_product_image | Write write | 0 | Delete a product Image. |
bigcommerce.bigcommerce_list_product_custom_fields | Read read | 0 | List custom-fields for a catalog product. |
bigcommerce.bigcommerce_get_product_custom_field | Read read | 0 | Get one product Custom Field. |
bigcommerce.bigcommerce_create_product_custom_field | Write write | 0 | Create a product Custom Field. |
bigcommerce.bigcommerce_update_product_custom_field | Write write | 0 | Update a product Custom Field. |
bigcommerce.bigcommerce_delete_product_custom_field | Write write | 0 | Delete a product Custom Field. |
bigcommerce.bigcommerce_list_product_modifiers | Read read | 0 | List modifiers for a catalog product. |
bigcommerce.bigcommerce_get_product_modifier | Read read | 0 | Get one product Modifier. |
bigcommerce.bigcommerce_create_product_modifier | Write write | 0 | Create a product Modifier. |
bigcommerce.bigcommerce_update_product_modifier | Write write | 0 | Update a product Modifier. |
bigcommerce.bigcommerce_delete_product_modifier | Write write | 0 | Delete a product Modifier. |
bigcommerce.bigcommerce_list_product_options | Read read | 0 | List options for a catalog product. |
bigcommerce.bigcommerce_get_product_option | Read read | 0 | Get one product Option. |
bigcommerce.bigcommerce_create_product_option | Write write | 0 | Create a product Option. |
bigcommerce.bigcommerce_update_product_option | Write write | 0 | Update a product Option. |
bigcommerce.bigcommerce_delete_product_option | Write write | 0 | Delete a product Option. |
bigcommerce.bigcommerce_list_product_videos | Read read | 0 | List videos for a catalog product. |
bigcommerce.bigcommerce_get_product_video | Read read | 0 | Get one product Video. |
bigcommerce.bigcommerce_create_product_video | Write write | 0 | Create a product Video. |
bigcommerce.bigcommerce_update_product_video | Write write | 0 | Update a product Video. |
bigcommerce.bigcommerce_delete_product_video | Write write | 0 | Delete a product Video. |
bigcommerce.bigcommerce_list_categories | Read read | 0 | List BigCommerce Categorys. |
bigcommerce.bigcommerce_get_category | Read read | 0 | Get one BigCommerce Category. |
bigcommerce.bigcommerce_create_category | Write write | 0 | Create a BigCommerce Category. |
bigcommerce.bigcommerce_update_category | Write write | 0 | Update a BigCommerce Category. |
bigcommerce.bigcommerce_delete_category | Write write | 0 | Delete a BigCommerce Category. |
bigcommerce.bigcommerce_list_brands | Read read | 0 | List BigCommerce Brands. |
bigcommerce.bigcommerce_get_brand | Read read | 0 | Get one BigCommerce Brand. |
bigcommerce.bigcommerce_create_brand | Write write | 0 | Create a BigCommerce Brand. |
bigcommerce.bigcommerce_update_brand | Write write | 0 | Update a BigCommerce Brand. |
bigcommerce.bigcommerce_delete_brand | Write write | 0 | Delete a BigCommerce Brand. |
bigcommerce.bigcommerce_list_category_trees | Read read | 0 | List BigCommerce Category Trees. |
bigcommerce.bigcommerce_get_category_tree | Read read | 0 | Get one BigCommerce Category Tree. |
bigcommerce.bigcommerce_create_category_tree | Write write | 0 | Create a BigCommerce Category Tree. |
bigcommerce.bigcommerce_update_category_tree | Write write | 0 | Update a BigCommerce Category Tree. |
bigcommerce.bigcommerce_delete_category_tree | Write write | 0 | Delete a BigCommerce Category Tree. |
bigcommerce.bigcommerce_list_price_lists | Read read | 0 | List BigCommerce Price Lists. |
bigcommerce.bigcommerce_get_price_list | Read read | 0 | Get one BigCommerce Price List. |
bigcommerce.bigcommerce_create_price_list | Write write | 0 | Create a BigCommerce Price List. |
bigcommerce.bigcommerce_update_price_list | Write write | 0 | Update a BigCommerce Price List. |
bigcommerce.bigcommerce_delete_price_list | Write write | 0 | Delete a BigCommerce Price List. |
bigcommerce.bigcommerce_list_price_list_records | Read read | 0 | List records for a BigCommerce price list. |
bigcommerce.bigcommerce_set_price_list_records | Write write | 0 | Create or update records for a BigCommerce price list. |
bigcommerce.bigcommerce_delete_price_list_records | Write write | 0 | Delete price list records by query filters. |
bigcommerce.bigcommerce_list_orders | Read read | 0 | List store orders with BigCommerce v2 filters. |
bigcommerce.bigcommerce_get_order | Read read | 0 | Get one order by ID. |
bigcommerce.bigcommerce_create_order | Write write | 0 | Create an order. |
bigcommerce.bigcommerce_update_order | Write write | 0 | Update an order. |
bigcommerce.bigcommerce_delete_order | Write write | 0 | Delete an order. |
bigcommerce.bigcommerce_list_order_products | Read read | 0 | List products for a BigCommerce order. |
bigcommerce.bigcommerce_list_shipping_addresses | Read read | 0 | List Order Shipping Addresses for an order. |
bigcommerce.bigcommerce_list_coupons | Read read | 0 | List Order Coupons for an order. |
bigcommerce.bigcommerce_list_transactions | Read read | 0 | List Order Transactions for an order. |
bigcommerce.bigcommerce_list_order_shipments | Read read | 0 | List shipments for an order. |
bigcommerce.bigcommerce_get_order_shipment | Read read | 0 | Get one shipment for an order. |
bigcommerce.bigcommerce_create_order_shipment | Write write | 0 | Create a shipment for an order. |
bigcommerce.bigcommerce_update_order_shipment | Write write | 0 | Update a shipment for an order. |
bigcommerce.bigcommerce_delete_order_shipment | Write write | 0 | Delete a shipment for an order. |
bigcommerce.bigcommerce_list_customers | Read read | 0 | List customers with BigCommerce v3 filters. |
bigcommerce.bigcommerce_get_customer | Read read | 0 | Get one customer by ID using the v3 customers filter. |
bigcommerce.bigcommerce_create_customers | Write write | 0 | Create one or more customers. |
bigcommerce.bigcommerce_update_customers | Write write | 0 | Update one or more customers. |
bigcommerce.bigcommerce_delete_customers | Write write | 0 | Delete customers by comma-separated IDs. |
bigcommerce.bigcommerce_list_customer_addresses | Read read | 0 | List Customer Addresses. |
bigcommerce.bigcommerce_get_customer_address | Read read | 0 | Get one record from Customer Addresses. |
bigcommerce.bigcommerce_create_customer_addresses | Write write | 0 | Create Customer Addresses. |
bigcommerce.bigcommerce_update_customer_addresses | Write write | 0 | Update Customer Addresses. |
bigcommerce.bigcommerce_delete_customer_addresses | Write write | 0 | Delete Customer Addresses by comma-separated IDs. |
bigcommerce.bigcommerce_list_customer_form_field_values | Read read | 0 | List Customer Form Field Values. |
bigcommerce.bigcommerce_get_customer_form_field_value | Read read | 0 | Get one record from Customer Form Field Values. |
bigcommerce.bigcommerce_create_customer_form_field_values | Write write | 0 | Create Customer Form Field Values. |
bigcommerce.bigcommerce_update_customer_form_field_values | Write write | 0 | Update Customer Form Field Values. |
bigcommerce.bigcommerce_delete_customer_form_field_values | Write write | 0 | Delete Customer Form Field Values by comma-separated IDs. |
bigcommerce.bigcommerce_list_customer_groups | Read read | 0 | List v2 customer groups. |
bigcommerce.bigcommerce_get_customer_group | Read read | 0 | Get one v2 customer group. |
bigcommerce.bigcommerce_create_customer_group | Write write | 0 | Create a v2 customer group. |
bigcommerce.bigcommerce_update_customer_group | Write write | 0 | Update a v2 customer group. |
bigcommerce.bigcommerce_delete_customer_group | Write write | 0 | Delete a v2 customer group. |
bigcommerce.bigcommerce_list_carts | Read read | 0 | List carts. |
bigcommerce.bigcommerce_get_cart | Read read | 0 | Get one cart. |
bigcommerce.bigcommerce_create_cart | Write write | 0 | Create a cart. |
bigcommerce.bigcommerce_delete_cart | Write write | 0 | Delete a cart. |
bigcommerce.bigcommerce_get_checkout | Read read | 0 | Get checkout details. |
bigcommerce.bigcommerce_update_checkout | Write write | 0 | Update checkout details. |
bigcommerce.bigcommerce_update_checkout_billing_address | Write write | 0 | Update checkout billing address. |
bigcommerce.bigcommerce_create_checkout_consignments | Write write | 0 | Create checkout consignments. |
bigcommerce.bigcommerce_update_checkout_consignment | Write write | 0 | Update a checkout consignment. |
bigcommerce.bigcommerce_delete_checkout_consignment | Write write | 0 | Delete a checkout consignment. |
bigcommerce.bigcommerce_get_store | Read read | 0 | Get store information. |
bigcommerce.bigcommerce_get_storefront_status | Read read | 0 | Get storefront status and verify API access. |
bigcommerce.bigcommerce_get_current_user | Read read | 0 | Compatibility alias that returns storefront status. |
bigcommerce.bigcommerce_list_channels | Read read | 0 | List BigCommerce Channels. |
bigcommerce.bigcommerce_get_channel | Read read | 0 | Get one BigCommerce Channel. |
bigcommerce.bigcommerce_create_channel | Write write | 0 | Create a BigCommerce Channel. |
bigcommerce.bigcommerce_update_channel | Write write | 0 | Update a BigCommerce Channel. |
bigcommerce.bigcommerce_delete_channel | Write write | 0 | Delete a BigCommerce Channel. |
bigcommerce.bigcommerce_list_sites | Read read | 0 | List BigCommerce Sites. |
bigcommerce.bigcommerce_get_site | Read read | 0 | Get one BigCommerce Site. |
bigcommerce.bigcommerce_create_site | Write write | 0 | Create a BigCommerce Site. |
bigcommerce.bigcommerce_update_site | Write write | 0 | Update a BigCommerce Site. |
bigcommerce.bigcommerce_delete_site | Write write | 0 | Delete a BigCommerce Site. |
bigcommerce.bigcommerce_list_webhooks | Read read | 0 | List BigCommerce Webhooks. |
bigcommerce.bigcommerce_get_webhook | Read read | 0 | Get one BigCommerce Webhook. |
bigcommerce.bigcommerce_create_webhook | Write write | 0 | Create a BigCommerce Webhook. |
bigcommerce.bigcommerce_update_webhook | Write write | 0 | Update a BigCommerce Webhook. |
bigcommerce.bigcommerce_delete_webhook | Write write | 0 | Delete a BigCommerce Webhook. |
bigcommerce.bigcommerce_list_content_pages | Read read | 0 | List BigCommerce Content Pages. |
bigcommerce.bigcommerce_get_content_page | Read read | 0 | Get one BigCommerce Content Page. |
bigcommerce.bigcommerce_create_content_page | Write write | 0 | Create a BigCommerce Content Page. |
bigcommerce.bigcommerce_update_content_page | Write write | 0 | Update a BigCommerce Content Page. |
bigcommerce.bigcommerce_delete_content_page | Write write | 0 | Delete a BigCommerce Content Page. |
bigcommerce.bigcommerce_list_widgets | Read read | 0 | List BigCommerce Widgets. |
bigcommerce.bigcommerce_get_widget | Read read | 0 | Get one BigCommerce Widget. |
bigcommerce.bigcommerce_create_widget | Write write | 0 | Create a BigCommerce Widget. |
bigcommerce.bigcommerce_update_widget | Write write | 0 | Update a BigCommerce Widget. |
bigcommerce.bigcommerce_delete_widget | Write write | 0 | Delete a BigCommerce Widget. |
bigcommerce.bigcommerce_list_widget_templates | Read read | 0 | List BigCommerce Widget Templates. |
bigcommerce.bigcommerce_get_widget_template | Read read | 0 | Get one BigCommerce Widget Template. |
bigcommerce.bigcommerce_create_widget_template | Write write | 0 | Create a BigCommerce Widget Template. |
bigcommerce.bigcommerce_update_widget_template | Write write | 0 | Update a BigCommerce Widget Template. |
bigcommerce.bigcommerce_delete_widget_template | Write write | 0 | Delete a BigCommerce Widget Template. |
bigcommerce.bigcommerce_list_redirects | Read read | 0 | List BigCommerce Redirects. |
bigcommerce.bigcommerce_get_redirect | Read read | 0 | Get one BigCommerce Redirect. |
bigcommerce.bigcommerce_create_redirect | Write write | 0 | Create a BigCommerce Redirect. |
bigcommerce.bigcommerce_update_redirect | Write write | 0 | Update a BigCommerce Redirect. |
bigcommerce.bigcommerce_delete_redirect | Write write | 0 | Delete a BigCommerce Redirect. |
bigcommerce.bigcommerce_list_regions | Read read | 0 | List content regions for widget placement. |