BigCommerce
120 actions · 1 auth method
PreviewEcommerceProductsCustomersOrdersShippingWebhooksContentMarketing
Authentication
API Key
Create a Store-level API account in your BigCommerce admin panel to get API credentials.Guides: Connector Profile, Link Account
Actions
|
No scopes found
120 actions
Action
Description
Required scopes
Get Store Information
Retrieve general store information including name, address, currency settings, and configuration details.
Get All Products
Retrieve a paginated list of products from the catalog with optional filtering.
Get A Product
Retrieve detailed information for a specific product by its ID.
Create A Product
Create a new product in the catalog.
Update A Product
Update an existing product’s attributes by its ID.
Delete A Product
Permanently delete a product from the catalog by its ID.
Get All Product Variants
Retrieve all product variants across the catalog.
Get All Product Variants By Product ID
Retrieve all variants for a specific product.
Get A Product Variant
Retrieve details for a specific product variant.
Create A Product Variant
Create a new variant for a product.
Update A Product Variant
Update an existing product variant.
Delete A Product Variant
Remove a product variant.
Get All Brands
Retrieve all product brands with optional filtering and pagination.
Get A Brand
Retrieve detailed information for a specific brand by its ID.
Create A Brand
Create a new product brand in the catalog.
Update A Brand
Update an existing brand’s attributes by its ID.
Delete A Brand
Permanently delete a brand by its ID.
Delete Brands
Delete multiple brands by name filter.
Get All Customers
Retrieve a paginated list of customers with optional filtering.
Get A Customer
Retrieve detailed information for a specific customer by their ID.
Create Customers
Create new customer accounts (up to 10 at once).
Update Customers
Update existing customers’ profile information (up to 10 at once).
Delete Customers
Permanently delete customers by their IDs.
Get All Orders
Retrieve a paginated list of orders with optional filtering by status, date, and customer.
Get An Order
Retrieve detailed information for a specific order by its ID.
Update An Order
Update an existing order’s status, products, addresses, or other details.
Create An Order
Create a new order with products and billing address.
Get All Order Statuses
Retrieve all available order statuses.
List Order Products
Retrieve all products/line items for a specific order.
List Order Shipments
Retrieve all shipments for a specific order.
Create A Shipment
Create a shipment for an order with tracking information.
Get Locations
Retrieve all inventory locations configured for the store.
Get A Location
Retrieve details for a specific inventory location by its ID.
Create Locations
Create new inventory locations.
Get Inventory At Locations
Retrieve inventory levels for items at specified locations.
Absolute Adjustment
Override existing inventory levels for items at locations.
Relative Adjustment
Add or subtract inventory for items at locations.
Get All Channels
Retrieve all sales channels configured for the store.
Get A Channel
Retrieve details for a specific channel by its ID.
Create A Channel
Create a new sales channel.
Update A Channel
Update an existing channel’s configuration.
Get All Currencies
Retrieve all currencies configured for the store.
Get A Currency
Retrieve details for a specific currency by its ID.
Create A Currency
Add a new currency to the store.
Update A Currency
Update an existing currency’s settings.
Delete A Currency
Remove a currency from the store.
Get Shipping Zones
Retrieve all shipping zones configured for the store.
Get A Shipping Zone
Retrieve details for a specific shipping zone by its ID.
Create A Shipping Zone
Create a new shipping zone.
Update A Shipping Zone
Update an existing shipping zone’s configuration.
Delete A Shipping Zone
Remove a shipping zone from the store.
Get Webhooks
Retrieve all webhooks registered for the store.
Get A Webhook
Retrieve details for a specific webhook by its ID.
Create A Webhook
Register a new webhook to receive event notifications.
Update A Webhook
Update an existing webhook’s configuration.
Delete A Webhook
Remove a webhook subscription.
Get All Wishlists
Retrieve all customer wishlists.
Get A Wishlist
Retrieve details for a specific wishlist by its ID.
Create A Wishlist
Create a new wishlist for a customer.
Update A Wishlist
Update an existing wishlist’s properties.
Delete A Wishlist
Remove a wishlist.
Get Pages
Retrieve all content pages from the store.
Get A Page
Retrieve details for a specific page by its ID.
Create A Page
Create a new content page.
Update A Page
Update an existing page’s content and settings.
Delete A Page
Remove a content page.
Get All Price Lists
Retrieve all price lists configured for the store.
Get A Price List
Retrieve details for a specific price list by its ID.
Create A Price List
Create a new price list.
Update A Price List
Update an existing price list’s properties.
Delete A Price List
Remove a price list.
Get All Coupons
Retrieve all coupons configured for the store.
Get A Coupon
Retrieve details for a specific coupon by its ID.
Create A Coupon
Create a new coupon code.
Update A Coupon
Update an existing coupon’s properties.
Delete A Coupon
Remove a coupon.
Get A Count Of Coupons
Returns a count of all coupons in the store.
Get Subscribers
Retrieve all newsletter subscribers.
Get A Subscriber
Retrieve details for a specific subscriber by ID.
Create A Subscriber
Add a new newsletter subscriber.
Delete Subscribers
Delete subscribers matching filter criteria.
Delete A Subscriber
Remove a newsletter subscriber by ID.
Get Tax Classes
Retrieve all tax classes configured for the store.
Get A Tax Class
Retrieve details for a specific tax class by ID.
Get All Countries
Retrieve all countries available in BigCommerce.
Get A Country
Retrieve details for a specific country by ID.
Get A Count Of All Countries
Returns a count of all countries.
Get All Country’s States
Retrieve all states or provinces for a country.
Get All Scripts
Retrieve all scripts installed on the store.
Get A Script
Retrieve details for a specific script by its UUID.
Create A Script
Add a new script to the storefront.
Update A Script
Update an existing script’s properties.
Delete A Script
Remove a script from the storefront.
Get Sites
Retrieve all sites/storefronts configured for the store.
Get A Site
Retrieve details for a specific site by ID.
Create A Site
Create a site that links a headless storefront to a sales channel.
Get All Themes
Retrieve all themes available for the store.
Get A Theme
Retrieve details for a specific theme by UUID.
Activate A Theme
Activate a theme variation on a channel.
Get All Categories
Retrieve a list of categories with filtering options.
Get All Category Trees
Retrieve all category trees for the store.
Upsert Category Trees
Create or update category trees.
Delete Category Trees
Delete one or more category trees.
Get A Category Tree
Retrieve a specific category tree with all its categories.
Create Categories
Create one or more categories.
Update Categories
Update one or more categories.
Delete Categories
Delete one or more categories.
Create A Cart
Create a new shopping cart.
Get A Cart
Retrieve a cart by its ID.
Delete A Cart
Delete a cart by its ID.
Add Cart Line Items
Add one or more items to a cart.
Update Cart Line Item
Update a line item in a cart.
Delete Cart Line Item
Remove a line item from a cart.
Get A Checkout
Retrieve a checkout by its ID.
Add Checkout Billing Address
Add a billing address to a checkout.
Update Checkout Billing Address
Update the billing address on a checkout.
Add Checkout Consignment
Add a shipping consignment to a checkout.
Update Checkout Consignment
Update a consignment on a checkout.
Delete Checkout Consignment
Remove a consignment from a checkout.
Create Order From Checkout
Create an order from a completed checkout.
Getting Started
Create or Select a Project
Set up a new project or select an existing one. See the Projects Guide.
Configure the Connector
Enable the connector and set up a connector profile in your project. See Managing Connectors.
Connector Profile
BigCommerce - API Key
Link an Account
Connect an account using StackOne Hub or Auth Link.
Link Account
BigCommerce - API Key
Use Actions
Invoke actions using one of the methods below:
- MCP – Model Context Protocol for AI assistants
- A2A – Agent-to-Agent protocol
- AI Toolset (TypeScript) – TypeScript SDK for AI agents
- AI Toolset (Python) – Python SDK for AI agents
- Actions RPC – Direct API calls
- Playground – Test actions in the dashboard