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.

productivity

BigCommerce Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the BigCommerce KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.bigcommerce.*. Use lua_read_doc("integrations.bigcommerce") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic BigCommerce workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.bigcommerce.list_products({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("bigcommerce"))' --json
kosmo integrations:lua --eval 'print(docs.read("bigcommerce.list_products"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local bigcommerce = app.integrations.bigcommerce
local result = bigcommerce.list_products({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.bigcommerce, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.bigcommerce.default.* or app.integrations.bigcommerce.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need BigCommerce, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

BigCommerce Lua Reference

Namespace: app.integrations.bigcommerce

BigCommerce tools use the Admin REST API. Configure access_token and store_hash; the service sends X-Auth-Token and builds https://api.bigcommerce.com/stores/{store_hash}. base_url is only needed for proxies or tests.

Most write tools accept a payload object containing the documented BigCommerce request body. Most list/read tools accept common parameters such as limit, page, and include, plus a query object for additional documented filters.

Common Examples

local products = app.integrations.bigcommerce.list_products({
  limit = 25,
  include = "variants,images",
  query = { ["is_visible"] = true }
})

local created = app.integrations.bigcommerce.create_product({
  payload = {
    name = "Example Widget",
    type = "physical",
    price = 29.99,
    weight = 1,
    categories = { 1 }
  }
})

local orders = app.integrations.bigcommerce.list_orders({
  status_id = 2,
  limit = 10
})

local customer = app.integrations.bigcommerce.get_customer({
  customer_id = 123
})

Coverage Notes

Catalog tools cover products and nested variants, images, custom fields, modifiers, options, videos, plus categories, brands, category trees, price lists, and price list records.
Order tools cover v2 order CRUD plus order products, shipping addresses, coupons, shipments, and v3 transactions.
Customer tools use v3 bulk-style endpoints. get_customer maps customer_id to BigCommerce id:in; delete tools map comma-separated IDs to id:in.
Cart and checkout tools cover cart CRUD, checkout lookup/update, billing addresses, and checkout consignments.
Store operations cover store info, storefront status, channels, sites, webhooks, content pages, widgets, widget templates, redirects, and regions.

Multi-Account Usage

app.integrations.bigcommerce.list_products({ limit = 10 })
app.integrations.bigcommerce.default.list_products({ limit = 10 })
app.integrations.bigcommerce.us_store.list_products({ limit = 10 })

All account namespaces expose the same tool names; only credentials differ.

Raw agent markdown

# BigCommerce Lua Reference

Namespace: `app.integrations.bigcommerce`

BigCommerce tools use the Admin REST API. Configure `access_token` and `store_hash`; the service sends `X-Auth-Token` and builds `https://api.bigcommerce.com/stores/{store_hash}`. `base_url` is only needed for proxies or tests.

Most write tools accept a `payload` object containing the documented BigCommerce request body. Most list/read tools accept common parameters such as `limit`, `page`, and `include`, plus a `query` object for additional documented filters.

## Common Examples

```lua
local products = app.integrations.bigcommerce.list_products({
  limit = 25,
  include = "variants,images",
  query = { ["is_visible"] = true }
})

local created = app.integrations.bigcommerce.create_product({
  payload = {
    name = "Example Widget",
    type = "physical",
    price = 29.99,
    weight = 1,
    categories = { 1 }
  }
})

local orders = app.integrations.bigcommerce.list_orders({
  status_id = 2,
  limit = 10
})

local customer = app.integrations.bigcommerce.get_customer({
  customer_id = 123
})
```

## Coverage Notes

- Catalog tools cover products and nested variants, images, custom fields, modifiers, options, videos, plus categories, brands, category trees, price lists, and price list records.
- Order tools cover v2 order CRUD plus order products, shipping addresses, coupons, shipments, and v3 transactions.
- Customer tools use v3 bulk-style endpoints. `get_customer` maps `customer_id` to BigCommerce `id:in`; delete tools map comma-separated IDs to `id:in`.
- Cart and checkout tools cover cart CRUD, checkout lookup/update, billing addresses, and checkout consignments.
- Store operations cover store info, storefront status, channels, sites, webhooks, content pages, widgets, widget templates, redirects, and regions.

## Multi-Account Usage

```lua
app.integrations.bigcommerce.list_products({ limit = 10 })
app.integrations.bigcommerce.default.list_products({ limit = 10 })
app.integrations.bigcommerce.us_store.list_products({ limit = 10 })
```

All account namespaces expose the same tool names; only credentials differ.

Metadata-derived Lua example

local result = app.integrations.bigcommerce.list_products({})
print(result)

Functions

list_products Read

List catalog products with BigCommerce v3 filters.

Lua path: app.integrations.bigcommerce.list_products
Full name: bigcommerce.bigcommerce_list_products

Parameter	Type	Required	Description
No parameters.

get_product Read

Get one catalog product by ID.

Lua path: app.integrations.bigcommerce.get_product
Full name: bigcommerce.bigcommerce_get_product

Parameter	Type	Required	Description
No parameters.

create_product Write

Create a catalog product.

Lua path: app.integrations.bigcommerce.create_product
Full name: bigcommerce.bigcommerce_create_product

Parameter	Type	Required	Description
No parameters.

update_product Write

Update a catalog product.

Lua path: app.integrations.bigcommerce.update_product
Full name: bigcommerce.bigcommerce_update_product

Parameter	Type	Required	Description
No parameters.

delete_product Write

Delete a catalog product.

Lua path: app.integrations.bigcommerce.delete_product
Full name: bigcommerce.bigcommerce_delete_product

Parameter	Type	Required	Description
No parameters.

list_product_variants Read

List variants for a catalog product.

Lua path: app.integrations.bigcommerce.list_product_variants
Full name: bigcommerce.bigcommerce_list_product_variants

Parameter	Type	Required	Description
No parameters.

get_product_variant Read

Get one product Variant.

Lua path: app.integrations.bigcommerce.get_product_variant
Full name: bigcommerce.bigcommerce_get_product_variant

Parameter	Type	Required	Description
No parameters.

create_product_variant Write

Create a product Variant.

Lua path: app.integrations.bigcommerce.create_product_variant
Full name: bigcommerce.bigcommerce_create_product_variant

Parameter	Type	Required	Description
No parameters.

update_product_variant Write

Update a product Variant.

Lua path: app.integrations.bigcommerce.update_product_variant
Full name: bigcommerce.bigcommerce_update_product_variant

Parameter	Type	Required	Description
No parameters.

delete_product_variant Write

Delete a product Variant.

Lua path: app.integrations.bigcommerce.delete_product_variant
Full name: bigcommerce.bigcommerce_delete_product_variant

Parameter	Type	Required	Description
No parameters.

list_product_images Read

List images for a catalog product.

Lua path: app.integrations.bigcommerce.list_product_images
Full name: bigcommerce.bigcommerce_list_product_images

Parameter	Type	Required	Description
No parameters.

get_product_image Read

Get one product Image.

Lua path: app.integrations.bigcommerce.get_product_image
Full name: bigcommerce.bigcommerce_get_product_image

Parameter	Type	Required	Description
No parameters.

create_product_image Write

Create a product Image.

Lua path: app.integrations.bigcommerce.create_product_image
Full name: bigcommerce.bigcommerce_create_product_image

Parameter	Type	Required	Description
No parameters.

update_product_image Write

Update a product Image.

Lua path: app.integrations.bigcommerce.update_product_image
Full name: bigcommerce.bigcommerce_update_product_image

Parameter	Type	Required	Description
No parameters.

delete_product_image Write

Delete a product Image.

Lua path: app.integrations.bigcommerce.delete_product_image
Full name: bigcommerce.bigcommerce_delete_product_image

Parameter	Type	Required	Description
No parameters.

list_product_custom_fields Read

List custom-fields for a catalog product.

Lua path: app.integrations.bigcommerce.list_product_custom_fields
Full name: bigcommerce.bigcommerce_list_product_custom_fields

Parameter	Type	Required	Description
No parameters.

get_product_custom_field Read

Get one product Custom Field.

Lua path: app.integrations.bigcommerce.get_product_custom_field
Full name: bigcommerce.bigcommerce_get_product_custom_field

Parameter	Type	Required	Description
No parameters.

create_product_custom_field Write

Create a product Custom Field.

Lua path: app.integrations.bigcommerce.create_product_custom_field
Full name: bigcommerce.bigcommerce_create_product_custom_field

Parameter	Type	Required	Description
No parameters.

update_product_custom_field Write

Update a product Custom Field.

Lua path: app.integrations.bigcommerce.update_product_custom_field
Full name: bigcommerce.bigcommerce_update_product_custom_field

Parameter	Type	Required	Description
No parameters.

delete_product_custom_field Write

Delete a product Custom Field.

Lua path: app.integrations.bigcommerce.delete_product_custom_field
Full name: bigcommerce.bigcommerce_delete_product_custom_field

Parameter	Type	Required	Description
No parameters.

list_product_modifiers Read

List modifiers for a catalog product.

Lua path: app.integrations.bigcommerce.list_product_modifiers
Full name: bigcommerce.bigcommerce_list_product_modifiers

Parameter	Type	Required	Description
No parameters.

get_product_modifier Read

Get one product Modifier.

Lua path: app.integrations.bigcommerce.get_product_modifier
Full name: bigcommerce.bigcommerce_get_product_modifier

Parameter	Type	Required	Description
No parameters.

create_product_modifier Write

Create a product Modifier.

Lua path: app.integrations.bigcommerce.create_product_modifier
Full name: bigcommerce.bigcommerce_create_product_modifier

Parameter	Type	Required	Description
No parameters.

update_product_modifier Write

Update a product Modifier.

Lua path: app.integrations.bigcommerce.update_product_modifier
Full name: bigcommerce.bigcommerce_update_product_modifier

Parameter	Type	Required	Description
No parameters.

delete_product_modifier Write

Delete a product Modifier.

Lua path: app.integrations.bigcommerce.delete_product_modifier
Full name: bigcommerce.bigcommerce_delete_product_modifier

Parameter	Type	Required	Description
No parameters.

list_product_options Read

List options for a catalog product.

Lua path: app.integrations.bigcommerce.list_product_options
Full name: bigcommerce.bigcommerce_list_product_options

Parameter	Type	Required	Description
No parameters.

get_product_option Read

Get one product Option.

Lua path: app.integrations.bigcommerce.get_product_option
Full name: bigcommerce.bigcommerce_get_product_option

Parameter	Type	Required	Description
No parameters.

create_product_option Write

Create a product Option.

Lua path: app.integrations.bigcommerce.create_product_option
Full name: bigcommerce.bigcommerce_create_product_option

Parameter	Type	Required	Description
No parameters.

update_product_option Write

Update a product Option.

Lua path: app.integrations.bigcommerce.update_product_option
Full name: bigcommerce.bigcommerce_update_product_option

Parameter	Type	Required	Description
No parameters.

delete_product_option Write

Delete a product Option.

Lua path: app.integrations.bigcommerce.delete_product_option
Full name: bigcommerce.bigcommerce_delete_product_option

Parameter	Type	Required	Description
No parameters.

list_product_videos Read

List videos for a catalog product.

Lua path: app.integrations.bigcommerce.list_product_videos
Full name: bigcommerce.bigcommerce_list_product_videos

Parameter	Type	Required	Description
No parameters.

get_product_video Read

Get one product Video.

Lua path: app.integrations.bigcommerce.get_product_video
Full name: bigcommerce.bigcommerce_get_product_video

Parameter	Type	Required	Description
No parameters.

create_product_video Write

Create a product Video.

Lua path: app.integrations.bigcommerce.create_product_video
Full name: bigcommerce.bigcommerce_create_product_video

Parameter	Type	Required	Description
No parameters.

update_product_video Write

Update a product Video.

Lua path: app.integrations.bigcommerce.update_product_video
Full name: bigcommerce.bigcommerce_update_product_video

Parameter	Type	Required	Description
No parameters.

delete_product_video Write

Delete a product Video.

Lua path: app.integrations.bigcommerce.delete_product_video
Full name: bigcommerce.bigcommerce_delete_product_video

Parameter	Type	Required	Description
No parameters.

list_categorys Read

List BigCommerce Categorys.

Lua path: app.integrations.bigcommerce.list_categorys
Full name: bigcommerce.bigcommerce_list_categories

Parameter	Type	Required	Description
No parameters.

get_category Read

Get one BigCommerce Category.

Lua path: app.integrations.bigcommerce.get_category
Full name: bigcommerce.bigcommerce_get_category

Parameter	Type	Required	Description
No parameters.

create_category Write

Create a BigCommerce Category.

Lua path: app.integrations.bigcommerce.create_category
Full name: bigcommerce.bigcommerce_create_category

Parameter	Type	Required	Description
No parameters.

update_category Write

Update a BigCommerce Category.

Lua path: app.integrations.bigcommerce.update_category
Full name: bigcommerce.bigcommerce_update_category

Parameter	Type	Required	Description
No parameters.

delete_category Write

Delete a BigCommerce Category.

Lua path: app.integrations.bigcommerce.delete_category
Full name: bigcommerce.bigcommerce_delete_category

Parameter	Type	Required	Description
No parameters.

list_brands Read

List BigCommerce Brands.

Lua path: app.integrations.bigcommerce.list_brands
Full name: bigcommerce.bigcommerce_list_brands

Parameter	Type	Required	Description
No parameters.

get_brand Read

Get one BigCommerce Brand.

Lua path: app.integrations.bigcommerce.get_brand
Full name: bigcommerce.bigcommerce_get_brand

Parameter	Type	Required	Description
No parameters.

create_brand Write

Create a BigCommerce Brand.

Lua path: app.integrations.bigcommerce.create_brand
Full name: bigcommerce.bigcommerce_create_brand

Parameter	Type	Required	Description
No parameters.

update_brand Write

Update a BigCommerce Brand.

Lua path: app.integrations.bigcommerce.update_brand
Full name: bigcommerce.bigcommerce_update_brand

Parameter	Type	Required	Description
No parameters.

delete_brand Write

Delete a BigCommerce Brand.

Lua path: app.integrations.bigcommerce.delete_brand
Full name: bigcommerce.bigcommerce_delete_brand

Parameter	Type	Required	Description
No parameters.

list_category_trees Read

List BigCommerce Category Trees.

Lua path: app.integrations.bigcommerce.list_category_trees
Full name: bigcommerce.bigcommerce_list_category_trees

Parameter	Type	Required	Description
No parameters.

get_category_tree Read

Get one BigCommerce Category Tree.

Lua path: app.integrations.bigcommerce.get_category_tree
Full name: bigcommerce.bigcommerce_get_category_tree

Parameter	Type	Required	Description
No parameters.

create_category_tree Write

Create a BigCommerce Category Tree.

Lua path: app.integrations.bigcommerce.create_category_tree
Full name: bigcommerce.bigcommerce_create_category_tree

Parameter	Type	Required	Description
No parameters.

update_category_tree Write

Update a BigCommerce Category Tree.

Lua path: app.integrations.bigcommerce.update_category_tree
Full name: bigcommerce.bigcommerce_update_category_tree

Parameter	Type	Required	Description
No parameters.

delete_category_tree Write

Delete a BigCommerce Category Tree.

Lua path: app.integrations.bigcommerce.delete_category_tree
Full name: bigcommerce.bigcommerce_delete_category_tree

Parameter	Type	Required	Description
No parameters.

list_price_lists Read

List BigCommerce Price Lists.

Lua path: app.integrations.bigcommerce.list_price_lists
Full name: bigcommerce.bigcommerce_list_price_lists

Parameter	Type	Required	Description
No parameters.

get_price_list Read

Get one BigCommerce Price List.

Lua path: app.integrations.bigcommerce.get_price_list
Full name: bigcommerce.bigcommerce_get_price_list

Parameter	Type	Required	Description
No parameters.

create_price_list Write

Create a BigCommerce Price List.

Lua path: app.integrations.bigcommerce.create_price_list
Full name: bigcommerce.bigcommerce_create_price_list

Parameter	Type	Required	Description
No parameters.

update_price_list Write

Update a BigCommerce Price List.

Lua path: app.integrations.bigcommerce.update_price_list
Full name: bigcommerce.bigcommerce_update_price_list

Parameter	Type	Required	Description
No parameters.

delete_price_list Write

Delete a BigCommerce Price List.

Lua path: app.integrations.bigcommerce.delete_price_list
Full name: bigcommerce.bigcommerce_delete_price_list

Parameter	Type	Required	Description
No parameters.

list_price_list_records Read

List records for a BigCommerce price list.

Lua path: app.integrations.bigcommerce.list_price_list_records
Full name: bigcommerce.bigcommerce_list_price_list_records

Parameter	Type	Required	Description
No parameters.

set_price_list_records Write

Create or update records for a BigCommerce price list.

Lua path: app.integrations.bigcommerce.set_price_list_records
Full name: bigcommerce.bigcommerce_set_price_list_records

Parameter	Type	Required	Description
No parameters.

delete_price_list_records Write

Delete price list records by query filters.

Lua path: app.integrations.bigcommerce.delete_price_list_records
Full name: bigcommerce.bigcommerce_delete_price_list_records

Parameter	Type	Required	Description
No parameters.

list_orders Read

List store orders with BigCommerce v2 filters.

Lua path: app.integrations.bigcommerce.list_orders
Full name: bigcommerce.bigcommerce_list_orders

Parameter	Type	Required	Description
No parameters.

get_order Read

Get one order by ID.

Lua path: app.integrations.bigcommerce.get_order
Full name: bigcommerce.bigcommerce_get_order

Parameter	Type	Required	Description
No parameters.

create_order Write

Create an order.

Lua path: app.integrations.bigcommerce.create_order
Full name: bigcommerce.bigcommerce_create_order

Parameter	Type	Required	Description
No parameters.

update_order Write

Update an order.

Lua path: app.integrations.bigcommerce.update_order
Full name: bigcommerce.bigcommerce_update_order

Parameter	Type	Required	Description
No parameters.

delete_order Write

Delete an order.

Lua path: app.integrations.bigcommerce.delete_order
Full name: bigcommerce.bigcommerce_delete_order

Parameter	Type	Required	Description
No parameters.

list_order_products Read

List products for a BigCommerce order.

Lua path: app.integrations.bigcommerce.list_order_products
Full name: bigcommerce.bigcommerce_list_order_products

Parameter	Type	Required	Description
No parameters.

list_order_shipping_addresses Read

List Order Shipping Addresses for an order.

Lua path: app.integrations.bigcommerce.list_order_shipping_addresses
Full name: bigcommerce.bigcommerce_list_shipping_addresses

Parameter	Type	Required	Description
No parameters.

list_order_coupons Read

List Order Coupons for an order.

Lua path: app.integrations.bigcommerce.list_order_coupons
Full name: bigcommerce.bigcommerce_list_coupons

Parameter	Type	Required	Description
No parameters.

list_order_transactions Read

List Order Transactions for an order.

Lua path: app.integrations.bigcommerce.list_order_transactions
Full name: bigcommerce.bigcommerce_list_transactions

Parameter	Type	Required	Description
No parameters.

list_order_shipments Read

List shipments for an order.

Lua path: app.integrations.bigcommerce.list_order_shipments
Full name: bigcommerce.bigcommerce_list_order_shipments

Parameter	Type	Required	Description
No parameters.

get_order_shipment Read

Get one shipment for an order.

Lua path: app.integrations.bigcommerce.get_order_shipment
Full name: bigcommerce.bigcommerce_get_order_shipment

Parameter	Type	Required	Description
No parameters.

create_order_shipment Write

Create a shipment for an order.

Lua path: app.integrations.bigcommerce.create_order_shipment
Full name: bigcommerce.bigcommerce_create_order_shipment

Parameter	Type	Required	Description
No parameters.

update_order_shipment Write

Update a shipment for an order.

Lua path: app.integrations.bigcommerce.update_order_shipment
Full name: bigcommerce.bigcommerce_update_order_shipment

Parameter	Type	Required	Description
No parameters.

delete_order_shipment Write

Delete a shipment for an order.

Lua path: app.integrations.bigcommerce.delete_order_shipment
Full name: bigcommerce.bigcommerce_delete_order_shipment

Parameter	Type	Required	Description
No parameters.

list_customers Read

List customers with BigCommerce v3 filters.

Lua path: app.integrations.bigcommerce.list_customers
Full name: bigcommerce.bigcommerce_list_customers

Parameter	Type	Required	Description
No parameters.

get_customer Read

Get one customer by ID using the v3 customers filter.

Lua path: app.integrations.bigcommerce.get_customer
Full name: bigcommerce.bigcommerce_get_customer

Parameter	Type	Required	Description
No parameters.

create_customers Write

Create one or more customers.

Lua path: app.integrations.bigcommerce.create_customers
Full name: bigcommerce.bigcommerce_create_customers

Parameter	Type	Required	Description
No parameters.

update_customers Write

Update one or more customers.

Lua path: app.integrations.bigcommerce.update_customers
Full name: bigcommerce.bigcommerce_update_customers

Parameter	Type	Required	Description
No parameters.

delete_customers Write

Delete customers by comma-separated IDs.

Lua path: app.integrations.bigcommerce.delete_customers
Full name: bigcommerce.bigcommerce_delete_customers

Parameter	Type	Required	Description
No parameters.

list_customer_addresses Read

List Customer Addresses.

Lua path: app.integrations.bigcommerce.list_customer_addresses
Full name: bigcommerce.bigcommerce_list_customer_addresses

Parameter	Type	Required	Description
No parameters.

get_customer_address Read

Get one record from Customer Addresses.

Lua path: app.integrations.bigcommerce.get_customer_address
Full name: bigcommerce.bigcommerce_get_customer_address

Parameter	Type	Required	Description
No parameters.

create_customer_addresses Write

Create Customer Addresses.

Lua path: app.integrations.bigcommerce.create_customer_addresses
Full name: bigcommerce.bigcommerce_create_customer_addresses

Parameter	Type	Required	Description
No parameters.

update_customer_addresses Write

Update Customer Addresses.

Lua path: app.integrations.bigcommerce.update_customer_addresses
Full name: bigcommerce.bigcommerce_update_customer_addresses

Parameter	Type	Required	Description
No parameters.

delete_customer_addresses Write

Delete Customer Addresses by comma-separated IDs.

Lua path: app.integrations.bigcommerce.delete_customer_addresses
Full name: bigcommerce.bigcommerce_delete_customer_addresses

Parameter	Type	Required	Description
No parameters.

list_customer_form_field_values Read

List Customer Form Field Values.

Lua path: app.integrations.bigcommerce.list_customer_form_field_values
Full name: bigcommerce.bigcommerce_list_customer_form_field_values

Parameter	Type	Required	Description
No parameters.

get_customer_form_field_value Read

Get one record from Customer Form Field Values.

Lua path: app.integrations.bigcommerce.get_customer_form_field_value
Full name: bigcommerce.bigcommerce_get_customer_form_field_value

Parameter	Type	Required	Description
No parameters.

create_customer_form_field_values Write

Create Customer Form Field Values.

Lua path: app.integrations.bigcommerce.create_customer_form_field_values
Full name: bigcommerce.bigcommerce_create_customer_form_field_values

Parameter	Type	Required	Description
No parameters.

update_customer_form_field_values Write

Update Customer Form Field Values.

Lua path: app.integrations.bigcommerce.update_customer_form_field_values
Full name: bigcommerce.bigcommerce_update_customer_form_field_values

Parameter	Type	Required	Description
No parameters.

delete_customer_form_field_values Write

Delete Customer Form Field Values by comma-separated IDs.

Lua path: app.integrations.bigcommerce.delete_customer_form_field_values
Full name: bigcommerce.bigcommerce_delete_customer_form_field_values

Parameter	Type	Required	Description
No parameters.

list_customer_groups Read

List v2 customer groups.

Lua path: app.integrations.bigcommerce.list_customer_groups
Full name: bigcommerce.bigcommerce_list_customer_groups

Parameter	Type	Required	Description
No parameters.

get_customer_group Read

Get one v2 customer group.

Lua path: app.integrations.bigcommerce.get_customer_group
Full name: bigcommerce.bigcommerce_get_customer_group

Parameter	Type	Required	Description
No parameters.

create_customer_group Write

Create a v2 customer group.

Lua path: app.integrations.bigcommerce.create_customer_group
Full name: bigcommerce.bigcommerce_create_customer_group

Parameter	Type	Required	Description
No parameters.

update_customer_group Write

Update a v2 customer group.

Lua path: app.integrations.bigcommerce.update_customer_group
Full name: bigcommerce.bigcommerce_update_customer_group

Parameter	Type	Required	Description
No parameters.

delete_customer_group Write

Delete a v2 customer group.

Lua path: app.integrations.bigcommerce.delete_customer_group
Full name: bigcommerce.bigcommerce_delete_customer_group

Parameter	Type	Required	Description
No parameters.

list_carts Read

List carts.

Lua path: app.integrations.bigcommerce.list_carts
Full name: bigcommerce.bigcommerce_list_carts

Parameter	Type	Required	Description
No parameters.

get_cart Read

Get one cart.

Lua path: app.integrations.bigcommerce.get_cart
Full name: bigcommerce.bigcommerce_get_cart

Parameter	Type	Required	Description
No parameters.

create_cart Write

Create a cart.

Lua path: app.integrations.bigcommerce.create_cart
Full name: bigcommerce.bigcommerce_create_cart

Parameter	Type	Required	Description
No parameters.

delete_cart Write

Delete a cart.

Lua path: app.integrations.bigcommerce.delete_cart
Full name: bigcommerce.bigcommerce_delete_cart

Parameter	Type	Required	Description
No parameters.

get_checkout Read

Get checkout details.

Lua path: app.integrations.bigcommerce.get_checkout
Full name: bigcommerce.bigcommerce_get_checkout

Parameter	Type	Required	Description
No parameters.

update_checkout Write

Update checkout details.

Lua path: app.integrations.bigcommerce.update_checkout
Full name: bigcommerce.bigcommerce_update_checkout

Parameter	Type	Required	Description
No parameters.

update_checkout_billing_address Write

Update checkout billing address.

Lua path: app.integrations.bigcommerce.update_checkout_billing_address
Full name: bigcommerce.bigcommerce_update_checkout_billing_address

Parameter	Type	Required	Description
No parameters.

create_checkout_consignments Write

Create checkout consignments.

Lua path: app.integrations.bigcommerce.create_checkout_consignments
Full name: bigcommerce.bigcommerce_create_checkout_consignments

Parameter	Type	Required	Description
No parameters.

update_checkout_consignment Write

Update a checkout consignment.

Lua path: app.integrations.bigcommerce.update_checkout_consignment
Full name: bigcommerce.bigcommerce_update_checkout_consignment

Parameter	Type	Required	Description
No parameters.

delete_checkout_consignment Write

Delete a checkout consignment.

Lua path: app.integrations.bigcommerce.delete_checkout_consignment
Full name: bigcommerce.bigcommerce_delete_checkout_consignment

Parameter	Type	Required	Description
No parameters.

get_store Read

Get store information.

Lua path: app.integrations.bigcommerce.get_store
Full name: bigcommerce.bigcommerce_get_store

Parameter	Type	Required	Description
No parameters.

get_storefront_status Read

Get storefront status and verify API access.

Lua path: app.integrations.bigcommerce.get_storefront_status
Full name: bigcommerce.bigcommerce_get_storefront_status

Parameter	Type	Required	Description
No parameters.

get_current_user Read

Compatibility alias that returns storefront status.

Lua path: app.integrations.bigcommerce.get_current_user
Full name: bigcommerce.bigcommerce_get_current_user

Parameter	Type	Required	Description
No parameters.

list_channels Read

List BigCommerce Channels.

Lua path: app.integrations.bigcommerce.list_channels
Full name: bigcommerce.bigcommerce_list_channels

Parameter	Type	Required	Description
No parameters.

get_channel Read

Get one BigCommerce Channel.

Lua path: app.integrations.bigcommerce.get_channel
Full name: bigcommerce.bigcommerce_get_channel

Parameter	Type	Required	Description
No parameters.

create_channel Write

Create a BigCommerce Channel.

Lua path: app.integrations.bigcommerce.create_channel
Full name: bigcommerce.bigcommerce_create_channel

Parameter	Type	Required	Description
No parameters.

update_channel Write

Update a BigCommerce Channel.

Lua path: app.integrations.bigcommerce.update_channel
Full name: bigcommerce.bigcommerce_update_channel

Parameter	Type	Required	Description
No parameters.

delete_channel Write

Delete a BigCommerce Channel.

Lua path: app.integrations.bigcommerce.delete_channel
Full name: bigcommerce.bigcommerce_delete_channel

Parameter	Type	Required	Description
No parameters.

list_sites Read

List BigCommerce Sites.

Lua path: app.integrations.bigcommerce.list_sites
Full name: bigcommerce.bigcommerce_list_sites

Parameter	Type	Required	Description
No parameters.

get_site Read

Get one BigCommerce Site.

Lua path: app.integrations.bigcommerce.get_site
Full name: bigcommerce.bigcommerce_get_site

Parameter	Type	Required	Description
No parameters.

create_site Write

Create a BigCommerce Site.

Lua path: app.integrations.bigcommerce.create_site
Full name: bigcommerce.bigcommerce_create_site

Parameter	Type	Required	Description
No parameters.

update_site Write

Update a BigCommerce Site.

Lua path: app.integrations.bigcommerce.update_site
Full name: bigcommerce.bigcommerce_update_site

Parameter	Type	Required	Description
No parameters.

delete_site Write

Delete a BigCommerce Site.

Lua path: app.integrations.bigcommerce.delete_site
Full name: bigcommerce.bigcommerce_delete_site

Parameter	Type	Required	Description
No parameters.

list_webhooks Read

List BigCommerce Webhooks.

Lua path: app.integrations.bigcommerce.list_webhooks
Full name: bigcommerce.bigcommerce_list_webhooks

Parameter	Type	Required	Description
No parameters.

get_webhook Read

Get one BigCommerce Webhook.

Lua path: app.integrations.bigcommerce.get_webhook
Full name: bigcommerce.bigcommerce_get_webhook

Parameter	Type	Required	Description
No parameters.

create_webhook Write

Create a BigCommerce Webhook.

Lua path: app.integrations.bigcommerce.create_webhook
Full name: bigcommerce.bigcommerce_create_webhook

Parameter	Type	Required	Description
No parameters.

update_webhook Write

Update a BigCommerce Webhook.

Lua path: app.integrations.bigcommerce.update_webhook
Full name: bigcommerce.bigcommerce_update_webhook

Parameter	Type	Required	Description
No parameters.

delete_webhook Write

Delete a BigCommerce Webhook.

Lua path: app.integrations.bigcommerce.delete_webhook
Full name: bigcommerce.bigcommerce_delete_webhook

Parameter	Type	Required	Description
No parameters.

list_content_pages Read

List BigCommerce Content Pages.

Lua path: app.integrations.bigcommerce.list_content_pages
Full name: bigcommerce.bigcommerce_list_content_pages

Parameter	Type	Required	Description
No parameters.

get_content_page Read

Get one BigCommerce Content Page.

Lua path: app.integrations.bigcommerce.get_content_page
Full name: bigcommerce.bigcommerce_get_content_page

Parameter	Type	Required	Description
No parameters.

create_content_page Write

Create a BigCommerce Content Page.

Lua path: app.integrations.bigcommerce.create_content_page
Full name: bigcommerce.bigcommerce_create_content_page

Parameter	Type	Required	Description
No parameters.

update_content_page Write

Update a BigCommerce Content Page.

Lua path: app.integrations.bigcommerce.update_content_page
Full name: bigcommerce.bigcommerce_update_content_page

Parameter	Type	Required	Description
No parameters.

delete_content_page Write

Delete a BigCommerce Content Page.

Lua path: app.integrations.bigcommerce.delete_content_page
Full name: bigcommerce.bigcommerce_delete_content_page

Parameter	Type	Required	Description
No parameters.

list_widgets Read

List BigCommerce Widgets.

Lua path: app.integrations.bigcommerce.list_widgets
Full name: bigcommerce.bigcommerce_list_widgets

Parameter	Type	Required	Description
No parameters.

get_widget Read

Get one BigCommerce Widget.

Lua path: app.integrations.bigcommerce.get_widget
Full name: bigcommerce.bigcommerce_get_widget

Parameter	Type	Required	Description
No parameters.

create_widget Write

Create a BigCommerce Widget.

Lua path: app.integrations.bigcommerce.create_widget
Full name: bigcommerce.bigcommerce_create_widget

Parameter	Type	Required	Description
No parameters.

update_widget Write

Update a BigCommerce Widget.

Lua path: app.integrations.bigcommerce.update_widget
Full name: bigcommerce.bigcommerce_update_widget

Parameter	Type	Required	Description
No parameters.

delete_widget Write

Delete a BigCommerce Widget.

Lua path: app.integrations.bigcommerce.delete_widget
Full name: bigcommerce.bigcommerce_delete_widget

Parameter	Type	Required	Description
No parameters.

list_widget_templates Read

List BigCommerce Widget Templates.

Lua path: app.integrations.bigcommerce.list_widget_templates
Full name: bigcommerce.bigcommerce_list_widget_templates

Parameter	Type	Required	Description
No parameters.

get_widget_template Read

Get one BigCommerce Widget Template.

Lua path: app.integrations.bigcommerce.get_widget_template
Full name: bigcommerce.bigcommerce_get_widget_template

Parameter	Type	Required	Description
No parameters.

create_widget_template Write

Create a BigCommerce Widget Template.

Lua path: app.integrations.bigcommerce.create_widget_template
Full name: bigcommerce.bigcommerce_create_widget_template

Parameter	Type	Required	Description
No parameters.

update_widget_template Write

Update a BigCommerce Widget Template.

Lua path: app.integrations.bigcommerce.update_widget_template
Full name: bigcommerce.bigcommerce_update_widget_template

Parameter	Type	Required	Description
No parameters.

delete_widget_template Write

Delete a BigCommerce Widget Template.

Lua path: app.integrations.bigcommerce.delete_widget_template
Full name: bigcommerce.bigcommerce_delete_widget_template

Parameter	Type	Required	Description
No parameters.

list_redirects Read

List BigCommerce Redirects.

Lua path: app.integrations.bigcommerce.list_redirects
Full name: bigcommerce.bigcommerce_list_redirects

Parameter	Type	Required	Description
No parameters.

get_redirect Read

Get one BigCommerce Redirect.

Lua path: app.integrations.bigcommerce.get_redirect
Full name: bigcommerce.bigcommerce_get_redirect

Parameter	Type	Required	Description
No parameters.

create_redirect Write

Create a BigCommerce Redirect.

Lua path: app.integrations.bigcommerce.create_redirect
Full name: bigcommerce.bigcommerce_create_redirect

Parameter	Type	Required	Description
No parameters.

update_redirect Write

Update a BigCommerce Redirect.

Lua path: app.integrations.bigcommerce.update_redirect
Full name: bigcommerce.bigcommerce_update_redirect

Parameter	Type	Required	Description
No parameters.

delete_redirect Write

Delete a BigCommerce Redirect.

Lua path: app.integrations.bigcommerce.delete_redirect
Full name: bigcommerce.bigcommerce_delete_redirect

Parameter	Type	Required	Description
No parameters.

list_regions Read

List content regions for widget placement.

Lua path: app.integrations.bigcommerce.list_regions
Full name: bigcommerce.bigcommerce_list_regions

Parameter	Type	Required	Description
No parameters.