BigCommerce MCP Server for Cloudflare Workers
79 tools available in the BigCommerce MCP server. Each tool can be called by AI assistants to perform specific actions.
bigcommerce_get_couponGet a single coupon by ID.
{
"type": "object",
"required": [
"couponId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"couponId": {
"type": "number",
"description": "Coupon ID"
}
}
}bigcommerce_delete_categoryDelete a category from the catalog.
Warning: This will also delete all subcategories. Products in deleted categories will be moved to no category.
{
"type": "object",
"required": [
"categoryId"
],
"properties": {
"categoryId": {
"type": "number",
"description": "Category ID to delete"
}
}
}bigcommerce_get_webhookGet a single webhook by ID.
{
"type": "object",
"required": [
"webhookId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"webhookId": {
"type": "number",
"description": "Webhook ID"
}
}
}bigcommerce_list_brandsList brands from the catalog with filtering and pagination.
Brands can be assigned to products to organize and filter catalog items.
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Filter by brand name (partial match)"
},
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page (max 250)"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_get_brandGet a single brand by ID.
Returns full brand details including SEO settings and custom URL.
{
"type": "object",
"required": [
"brandId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"brandId": {
"type": "number",
"description": "Brand ID"
}
}
}bigcommerce_create_brandCreate a new brand.
Returns the created brand with its assigned ID.
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Brand name"
},
"imageUrl": {
"type": "string",
"description": "Brand image URL"
},
"pageTitle": {
"type": "string",
"description": "SEO page title"
},
"metaKeywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "SEO meta keywords"
},
"searchKeywords": {
"type": "string",
"description": "Search keywords"
},
"metaDescription": {
"type": "string",
"description": "SEO meta description"
}
}
}bigcommerce_update_brandUpdate an existing brand.
All fields are optional - only provided fields will be updated.
{
"type": "object",
"required": [
"brandId"
],
"properties": {
"name": {
"type": "string",
"description": "Brand name"
},
"brandId": {
"type": "number",
"description": "Brand ID to update"
},
"imageUrl": {
"type": "string",
"description": "Brand image URL"
},
"pageTitle": {
"type": "string",
"description": "SEO page title"
},
"metaKeywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "SEO meta keywords"
},
"searchKeywords": {
"type": "string",
"description": "Search keywords"
},
"metaDescription": {
"type": "string",
"description": "SEO meta description"
}
}
}bigcommerce_delete_brandDelete a brand from the catalog.
Warning: Products using this brand will have their brand association removed.
{
"type": "object",
"required": [
"brandId"
],
"properties": {
"brandId": {
"type": "number",
"description": "Brand ID to delete"
}
}
}bigcommerce_list_categoriesList categories from the catalog with filtering and pagination.
Categories can be organized hierarchically using parent_id.
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Filter by category name"
},
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page (max 250)"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"parentId": {
"type": "number",
"description": "Filter by parent category ID (0 for root)"
},
"isVisible": {
"type": "boolean",
"description": "Filter by visibility"
}
}
}bigcommerce_get_categoryGet a single category by ID.
Returns full category details including SEO settings, sort order, and custom URL.
{
"type": "object",
"required": [
"categoryId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"categoryId": {
"type": "number",
"description": "Category ID"
}
}
}bigcommerce_create_categoryCreate a new category in the catalog.
Set parentId to 0 for root-level categories, or specify a parent category ID for subcategories.
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Category name"
},
"parentId": {
"type": "number",
"default": 0,
"description": "Parent category ID (0 for root)"
},
"isVisible": {
"type": "boolean",
"description": "Visible on storefront"
},
"pageTitle": {
"type": "string",
"description": "SEO page title"
},
"sortOrder": {
"type": "number",
"description": "Sort order"
},
"description": {
"type": "string",
"description": "Category description (HTML allowed)"
},
"metaKeywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "SEO meta keywords"
},
"metaDescription": {
"type": "string",
"description": "SEO meta description"
}
}
}bigcommerce_update_categoryUpdate an existing category.
All fields are optional - only provided fields will be updated.
{
"type": "object",
"required": [
"categoryId"
],
"properties": {
"name": {
"type": "string",
"description": "Category name"
},
"parentId": {
"type": "number",
"description": "Parent category ID"
},
"isVisible": {
"type": "boolean",
"description": "Visible on storefront"
},
"pageTitle": {
"type": "string",
"description": "SEO page title"
},
"sortOrder": {
"type": "number",
"description": "Sort order"
},
"categoryId": {
"type": "number",
"description": "Category ID to update"
},
"description": {
"type": "string",
"description": "Category description"
},
"metaKeywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "SEO meta keywords"
},
"metaDescription": {
"type": "string",
"description": "SEO meta description"
}
}
}bigcommerce_list_customersList customers with filtering and pagination.
Supports filtering by email, name, company, customer group, and date range.
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Filter by name (partial match)"
},
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"email": {
"type": "string",
"description": "Filter by exact email"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page (max 250)"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"company": {
"type": "string",
"description": "Filter by company (partial match)"
},
"include": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related data to include"
},
"dateCreatedMax": {
"type": "string",
"description": "Maximum date created"
},
"dateCreatedMin": {
"type": "string",
"description": "Minimum date created (ISO 8601)"
},
"customerGroupId": {
"type": "number",
"description": "Filter by customer group ID"
}
}
}bigcommerce_get_customerGet a single customer by ID.
Returns full customer details including contact info, notes, and store credit.
{
"type": "object",
"required": [
"customerId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"include": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related data to include"
},
"customerId": {
"type": "number",
"description": "Customer ID"
}
}
}bigcommerce_create_customerCreate a new customer.
Required fields: email, firstName, lastName. Returns the created customer.
{
"type": "object",
"required": [
"email",
"firstName",
"lastName"
],
"properties": {
"email": {
"type": "string",
"description": "Customer email"
},
"notes": {
"type": "string",
"description": "Internal notes"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"company": {
"type": "string",
"description": "Company name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"firstName": {
"type": "string",
"description": "First name"
},
"customerGroupId": {
"type": "number",
"description": "Customer group ID"
}
}
}bigcommerce_update_customerUpdate an existing customer.
All fields are optional - only provided fields will be updated.
{
"type": "object",
"required": [
"customerId"
],
"properties": {
"email": {
"type": "string",
"description": "Customer email"
},
"notes": {
"type": "string",
"description": "Internal notes"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"company": {
"type": "string",
"description": "Company name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"firstName": {
"type": "string",
"description": "First name"
},
"customerId": {
"type": "number",
"description": "Customer ID to update"
},
"customerGroupId": {
"type": "number",
"description": "Customer group ID"
}
}
}bigcommerce_delete_customerDelete a customer.
Warning: This will also delete all associated addresses and order history.
{
"type": "object",
"required": [
"customerId"
],
"properties": {
"customerId": {
"type": "number",
"description": "Customer ID to delete"
}
}
}bigcommerce_list_customer_addressesList addresses for customers.
Can filter by customer ID to get addresses for a specific customer.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"customerId": {
"type": "number",
"description": "Filter by customer ID"
}
}
}bigcommerce_create_customer_addressCreate a new address for a customer.
{
"type": "object",
"required": [
"customerId",
"firstName",
"lastName",
"address1",
"city",
"stateOrProvince",
"postalCode",
"countryCode"
],
"properties": {
"city": {
"type": "string",
"description": "City"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"company": {
"type": "string",
"description": "Company"
},
"address1": {
"type": "string",
"description": "Address line 1"
},
"address2": {
"type": "string",
"description": "Address line 2"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"firstName": {
"type": "string",
"description": "First name"
},
"customerId": {
"type": "number",
"description": "Customer ID"
},
"postalCode": {
"type": "string",
"description": "Postal/ZIP code"
},
"addressType": {
"enum": [
"residential",
"commercial"
],
"type": "string",
"description": "Address type"
},
"countryCode": {
"type": "string",
"description": "Country code (ISO 2-letter)"
},
"stateOrProvince": {
"type": "string",
"description": "State or province"
}
}
}bigcommerce_update_customer_addressUpdate an existing customer address.
{
"type": "object",
"required": [
"addressId"
],
"properties": {
"city": {
"type": "string",
"description": "City"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"company": {
"type": "string",
"description": "Company"
},
"address1": {
"type": "string",
"description": "Address line 1"
},
"address2": {
"type": "string",
"description": "Address line 2"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"addressId": {
"type": "number",
"description": "Address ID to update"
},
"firstName": {
"type": "string",
"description": "First name"
},
"postalCode": {
"type": "string",
"description": "Postal/ZIP code"
},
"addressType": {
"enum": [
"residential",
"commercial"
],
"type": "string",
"description": "Address type"
},
"countryCode": {
"type": "string",
"description": "Country code"
},
"stateOrProvince": {
"type": "string",
"description": "State or province"
}
}
}bigcommerce_delete_customer_addressDelete a customer address.
{
"type": "object",
"required": [
"addressId"
],
"properties": {
"addressId": {
"type": "number",
"description": "Address ID to delete"
}
}
}bigcommerce_list_customer_groupsList customer groups.
Customer groups can have special pricing and category access rules.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_get_customer_groupGet a single customer group by ID.
Returns group details including discount rules and category access.
{
"type": "object",
"required": [
"groupId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"groupId": {
"type": "number",
"description": "Customer group ID"
}
}
}bigcommerce_list_couponsList coupons with filtering and pagination.
Coupons provide discount codes that customers can apply at checkout.
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Filter by coupon code"
},
"name": {
"type": "string",
"description": "Filter by coupon name"
},
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_create_couponCreate a new coupon.
Coupon types:
{
"type": "object",
"required": [
"name",
"code",
"amount"
],
"properties": {
"code": {
"type": "string",
"description": "Coupon code (what customers enter)"
},
"name": {
"type": "string",
"description": "Coupon name"
},
"amount": {
"type": "string",
"description": "Discount amount"
},
"enabled": {
"type": "boolean",
"description": "Whether coupon is active"
},
"expires": {
"type": "string",
"description": "Expiration date (RFC 2822)"
},
"maxUses": {
"type": "number",
"description": "Maximum number of uses"
},
"minPurchase": {
"type": "string",
"description": "Minimum purchase amount"
},
"maxUsesPerCustomer": {
"type": "number",
"description": "Max uses per customer"
}
}
}bigcommerce_update_couponUpdate an existing coupon.
{
"type": "object",
"required": [
"couponId"
],
"properties": {
"code": {
"type": "string",
"description": "Coupon code"
},
"name": {
"type": "string",
"description": "Coupon name"
},
"amount": {
"type": "string",
"description": "Discount amount"
},
"enabled": {
"type": "boolean",
"description": "Whether coupon is active"
},
"expires": {
"type": "string",
"description": "Expiration date"
},
"maxUses": {
"type": "number",
"description": "Maximum number of uses"
},
"couponId": {
"type": "number",
"description": "Coupon ID to update"
},
"minPurchase": {
"type": "string",
"description": "Minimum purchase amount"
},
"maxUsesPerCustomer": {
"type": "number",
"description": "Max uses per customer"
}
}
}bigcommerce_delete_couponDelete a coupon.
{
"type": "object",
"required": [
"couponId"
],
"properties": {
"couponId": {
"type": "number",
"description": "Coupon ID to delete"
}
}
}bigcommerce_list_promotionsList promotions.
Promotions are more flexible than coupons and can be automatic or require codes.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_get_promotionGet a single promotion by ID.
{
"type": "object",
"required": [
"promotionId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"promotionId": {
"type": "number",
"description": "Promotion ID"
}
}
}bigcommerce_delete_promotionDelete a promotion.
{
"type": "object",
"required": [
"promotionId"
],
"properties": {
"promotionId": {
"type": "number",
"description": "Promotion ID to delete"
}
}
}bigcommerce_get_store_infoGet store information including name, domain, plan, settings, and features.
Returns store configuration including:
{
"type": "object",
"properties": {}
}bigcommerce_list_ordersList orders with filtering and pagination.
Supports filtering by status, customer, date range, total amount, and payment method.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page (max 250)"
},
"maxId": {
"type": "number",
"description": "Maximum order ID"
},
"minId": {
"type": "number",
"description": "Minimum order ID"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"maxTotal": {
"type": "number",
"description": "Maximum order total"
},
"minTotal": {
"type": "number",
"description": "Minimum order total"
},
"statusId": {
"type": "number",
"description": "Filter by status ID"
},
"isDeleted": {
"type": "boolean",
"description": "Include deleted orders"
},
"customerId": {
"type": "number",
"description": "Filter by customer ID"
},
"paymentMethod": {
"type": "string",
"description": "Filter by payment method"
},
"maxDateCreated": {
"type": "string",
"description": "Maximum date created"
},
"minDateCreated": {
"type": "string",
"description": "Minimum date created (RFC 2822 or ISO 8601)"
}
}
}bigcommerce_get_orderGet a single order by ID.
Returns full order details including billing address, totals, and resource URLs.
{
"type": "object",
"required": [
"orderId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"orderId": {
"type": "number",
"description": "Order ID"
}
}
}bigcommerce_get_order_countGet the count of orders matching criteria.
Useful for analytics and reporting without fetching full order data.
{
"type": "object",
"properties": {
"statusId": {
"type": "number",
"description": "Filter by status ID"
},
"maxDateCreated": {
"type": "string",
"description": "Maximum date created"
},
"minDateCreated": {
"type": "string",
"description": "Minimum date created"
}
}
}bigcommerce_update_orderUpdate an existing order.
Use this to change order status, add staff notes, or update customer messages.
{
"type": "object",
"required": [
"orderId"
],
"properties": {
"orderId": {
"type": "number",
"description": "Order ID to update"
},
"statusId": {
"type": "number",
"description": "New status ID"
},
"staffNotes": {
"type": "string",
"description": "Internal staff notes"
},
"customerMessage": {
"type": "string",
"description": "Customer-visible message"
}
}
}bigcommerce_delete_orderDelete an order.
Warning: This will mark the order as deleted. Use with caution.
{
"type": "object",
"required": [
"orderId"
],
"properties": {
"orderId": {
"type": "number",
"description": "Order ID to delete"
}
}
}bigcommerce_list_order_productsList products/line items in an order.
{
"type": "object",
"required": [
"orderId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"orderId": {
"type": "number",
"description": "Order ID"
}
}
}bigcommerce_get_order_productGet details of a specific product in an order.
{
"type": "object",
"required": [
"orderId",
"productId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"orderId": {
"type": "number",
"description": "Order ID"
},
"productId": {
"type": "number",
"description": "Order product ID (not catalog product ID)"
}
}
}bigcommerce_list_order_shipmentsList shipments for an order.
{
"type": "object",
"required": [
"orderId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"orderId": {
"type": "number",
"description": "Order ID"
}
}
}bigcommerce_get_order_shipmentGet details of a specific shipment.
{
"type": "object",
"required": [
"orderId",
"shipmentId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"orderId": {
"type": "number",
"description": "Order ID"
},
"shipmentId": {
"type": "number",
"description": "Shipment ID"
}
}
}bigcommerce_create_order_shipmentCreate a shipment for an order.
This will trigger shipment notification emails to the customer.
{
"type": "object",
"required": [
"orderId",
"orderAddressId"
],
"properties": {
"orderId": {
"type": "number",
"description": "Order ID"
},
"comments": {
"type": "string",
"description": "Shipment comments"
},
"orderAddressId": {
"type": "number",
"description": "Shipping address ID from the order"
},
"shippingMethod": {
"type": "string",
"description": "Shipping method name"
},
"trackingNumber": {
"type": "string",
"description": "Tracking number"
}
}
}bigcommerce_update_order_shipmentUpdate a shipment.
Use this to add or update tracking information.
{
"type": "object",
"required": [
"orderId",
"shipmentId"
],
"properties": {
"orderId": {
"type": "number",
"description": "Order ID"
},
"comments": {
"type": "string",
"description": "Shipment comments"
},
"shipmentId": {
"type": "number",
"description": "Shipment ID"
},
"shippingMethod": {
"type": "string",
"description": "Shipping method name"
},
"trackingNumber": {
"type": "string",
"description": "Tracking number"
}
}
}bigcommerce_delete_order_shipmentDelete a shipment from an order.
Note: This does not change the order status.
{
"type": "object",
"required": [
"orderId",
"shipmentId"
],
"properties": {
"orderId": {
"type": "number",
"description": "Order ID"
},
"shipmentId": {
"type": "number",
"description": "Shipment ID to delete"
}
}
}bigcommerce_list_order_shipping_addressesList shipping addresses for an order.
Orders can have multiple shipping addresses for split shipments.
{
"type": "object",
"required": [
"orderId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"orderId": {
"type": "number",
"description": "Order ID"
}
}
}bigcommerce_list_productsList products from the catalog with filtering and pagination.
Supports filtering by name, SKU, visibility, brand, categories, availability, and featured status. Use include parameter to fetch related data like images, variants, and custom fields.
{
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Filter by SKU"
},
"name": {
"type": "string",
"description": "Filter by product name"
},
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page (max 250)"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"brandId": {
"type": "number",
"description": "Filter by brand ID"
},
"keyword": {
"type": "string",
"description": "Search keyword"
},
"isVisible": {
"type": "boolean",
"description": "Filter by visibility"
},
"categories": {
"type": "array",
"items": {
"type": "number"
},
"description": "Filter by category IDs"
},
"isFeatured": {
"type": "boolean",
"description": "Filter by featured status"
}
}
}bigcommerce_get_productGet a single product by ID with optional related data.
Returns full product details including pricing, inventory, dimensions, categories, and optional related data.
{
"type": "object",
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_create_productCreate a new product in the catalog.
Required fields: name, type (physical, digital), price, weight. Returns the created product.
{
"type": "object",
"required": [
"name",
"type",
"price",
"weight"
],
"properties": {
"sku": {
"type": "string",
"description": "Product SKU"
},
"name": {
"type": "string",
"description": "Product name"
},
"type": {
"enum": [
"physical",
"digital"
],
"type": "string",
"description": "Product type"
},
"depth": {
"type": "number",
"description": "Product depth"
},
"price": {
"type": "number",
"description": "Product price"
},
"width": {
"type": "number",
"description": "Product width"
},
"height": {
"type": "number",
"description": "Product height"
},
"weight": {
"type": "number",
"description": "Product weight"
},
"brandId": {
"type": "number",
"description": "Brand ID"
},
"condition": {
"enum": [
"New",
"Used",
"Refurbished"
],
"type": "string",
"description": "Product condition"
},
"costPrice": {
"type": "number",
"description": "Cost price"
},
"isVisible": {
"type": "boolean",
"description": "Visible on storefront"
},
"salePrice": {
"type": "number",
"description": "Sale price"
},
"categories": {
"type": "array",
"items": {
"type": "number"
},
"description": "Category IDs"
},
"isFeatured": {
"type": "boolean",
"description": "Featured product"
},
"description": {
"type": "string",
"description": "Product description (HTML allowed)"
},
"retailPrice": {
"type": "number",
"description": "Retail price (MSRP)"
},
"inventoryLevel": {
"type": "number",
"description": "Inventory level"
}
}
}bigcommerce_update_productUpdate an existing product.
All fields are optional - only provided fields will be updated.
{
"type": "object",
"required": [
"productId"
],
"properties": {
"sku": {
"type": "string",
"description": "Product SKU"
},
"name": {
"type": "string",
"description": "Product name"
},
"type": {
"enum": [
"physical",
"digital"
],
"type": "string",
"description": "Product type"
},
"depth": {
"type": "number",
"description": "Product depth"
},
"price": {
"type": "number",
"description": "Product price"
},
"width": {
"type": "number",
"description": "Product width"
},
"height": {
"type": "number",
"description": "Product height"
},
"weight": {
"type": "number",
"description": "Product weight"
},
"brandId": {
"type": "number",
"description": "Brand ID"
},
"condition": {
"enum": [
"New",
"Used",
"Refurbished"
],
"type": "string",
"description": "Product condition"
},
"costPrice": {
"type": "number",
"description": "Cost price"
},
"isVisible": {
"type": "boolean",
"description": "Visible on storefront"
},
"productId": {
"type": "number",
"description": "Product ID to update"
},
"salePrice": {
"type": "number",
"description": "Sale price"
},
"categories": {
"type": "array",
"items": {
"type": "number"
},
"description": "Category IDs"
},
"isFeatured": {
"type": "boolean",
"description": "Featured product"
},
"description": {
"type": "string",
"description": "Product description"
},
"retailPrice": {
"type": "number",
"description": "Retail price"
},
"availability": {
"enum": [
"available",
"disabled",
"preorder"
],
"type": "string",
"description": "Availability"
},
"inventoryLevel": {
"type": "number",
"description": "Inventory level"
},
"inventoryTracking": {
"enum": [
"none",
"product",
"variant"
],
"type": "string",
"description": "Inventory tracking"
}
}
}bigcommerce_delete_productDelete a product from the catalog.
Warning: This action is permanent and cannot be undone.
{
"type": "object",
"required": [
"productId"
],
"properties": {
"productId": {
"type": "number",
"description": "Product ID to delete"
}
}
}bigcommerce_list_product_variantsList variants for a product.
Variants are different versions of a product (e.g., size/color combinations).
{
"type": "object",
"required": [
"productId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_get_product_variantGet a single product variant by ID.
{
"type": "object",
"required": [
"productId",
"variantId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"productId": {
"type": "number",
"description": "Product ID"
},
"variantId": {
"type": "number",
"description": "Variant ID"
}
}
}bigcommerce_update_price_listUpdate an existing price list.
{
"type": "object",
"required": [
"priceListId"
],
"properties": {
"name": {
"type": "string",
"description": "Price list name"
},
"active": {
"type": "boolean",
"description": "Whether price list is active"
},
"priceListId": {
"type": "number",
"description": "Price list ID to update"
}
}
}bigcommerce_update_product_variantUpdate a product variant.
Use this to update variant-specific pricing, inventory, or other attributes.
{
"type": "object",
"required": [
"productId",
"variantId"
],
"properties": {
"sku": {
"type": "string",
"description": "Variant SKU"
},
"depth": {
"type": "number",
"description": "Depth"
},
"price": {
"type": "number",
"description": "Variant price"
},
"width": {
"type": "number",
"description": "Width"
},
"height": {
"type": "number",
"description": "Height"
},
"weight": {
"type": "number",
"description": "Weight"
},
"costPrice": {
"type": "number",
"description": "Cost price"
},
"productId": {
"type": "number",
"description": "Product ID"
},
"salePrice": {
"type": "number",
"description": "Sale price"
},
"variantId": {
"type": "number",
"description": "Variant ID"
},
"retailPrice": {
"type": "number",
"description": "Retail price"
},
"inventoryLevel": {
"type": "number",
"description": "Inventory level"
},
"isFreeShipping": {
"type": "boolean",
"description": "Free shipping"
},
"purchasingDisabled": {
"type": "boolean",
"description": "Disable purchasing"
}
}
}bigcommerce_list_product_imagesList images for a product.
{
"type": "object",
"required": [
"productId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_create_product_imageAdd an image to a product by URL.
{
"type": "object",
"required": [
"productId",
"imageUrl"
],
"properties": {
"imageUrl": {
"type": "string",
"description": "URL of the image to add"
},
"productId": {
"type": "number",
"description": "Product ID"
},
"sortOrder": {
"type": "number",
"description": "Sort order"
},
"description": {
"type": "string",
"description": "Image alt text/description"
},
"isThumbnail": {
"type": "boolean",
"description": "Set as thumbnail image"
}
}
}bigcommerce_delete_product_imageDelete an image from a product.
{
"type": "object",
"required": [
"productId",
"imageId"
],
"properties": {
"imageId": {
"type": "number",
"description": "Image ID to delete"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_list_product_custom_fieldsList custom fields for a product.
Custom fields store additional product metadata displayed on the storefront.
{
"type": "object",
"required": [
"productId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_create_product_custom_fieldAdd a custom field to a product.
{
"type": "object",
"required": [
"productId",
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Custom field name"
},
"value": {
"type": "string",
"description": "Custom field value"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_update_product_custom_fieldUpdate a product custom field.
{
"type": "object",
"required": [
"productId",
"customFieldId"
],
"properties": {
"name": {
"type": "string",
"description": "Custom field name"
},
"value": {
"type": "string",
"description": "Custom field value"
},
"productId": {
"type": "number",
"description": "Product ID"
},
"customFieldId": {
"type": "number",
"description": "Custom field ID"
}
}
}bigcommerce_delete_product_custom_fieldDelete a custom field from a product.
{
"type": "object",
"required": [
"productId",
"customFieldId"
],
"properties": {
"productId": {
"type": "number",
"description": "Product ID"
},
"customFieldId": {
"type": "number",
"description": "Custom field ID to delete"
}
}
}bigcommerce_list_product_reviewsList reviews for a product.
{
"type": "object",
"required": [
"productId"
],
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_create_product_reviewCreate a review for a product.
{
"type": "object",
"required": [
"productId",
"title",
"text",
"rating",
"name",
"email"
],
"properties": {
"name": {
"type": "string",
"description": "Reviewer name"
},
"text": {
"type": "string",
"description": "Review text"
},
"email": {
"type": "string",
"description": "Reviewer email"
},
"title": {
"type": "string",
"description": "Review title"
},
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"description": "Rating (1-5)"
},
"status": {
"enum": [
"approved",
"disapproved",
"pending"
],
"type": "string",
"description": "Review status"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_update_product_reviewUpdate a product review.
{
"type": "object",
"required": [
"productId",
"reviewId"
],
"properties": {
"text": {
"type": "string",
"description": "Review text"
},
"title": {
"type": "string",
"description": "Review title"
},
"rating": {
"type": "integer",
"maximum": 5,
"minimum": 1,
"description": "Rating (1-5)"
},
"status": {
"enum": [
"approved",
"disapproved",
"pending"
],
"type": "string",
"description": "Review status"
},
"reviewId": {
"type": "number",
"description": "Review ID"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_delete_product_reviewDelete a product review.
{
"type": "object",
"required": [
"productId",
"reviewId"
],
"properties": {
"reviewId": {
"type": "number",
"description": "Review ID to delete"
},
"productId": {
"type": "number",
"description": "Product ID"
}
}
}bigcommerce_delete_price_listDelete a price list.
{
"type": "object",
"required": [
"priceListId"
],
"properties": {
"priceListId": {
"type": "number",
"description": "Price list ID to delete"
}
}
}bigcommerce_list_webhooksList webhooks configured for the store.
Webhooks send HTTP POST notifications when events occur in your store.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_create_webhookCreate a new webhook.
Common scopes:
{
"type": "object",
"required": [
"scope",
"destination"
],
"properties": {
"scope": {
"type": "string",
"description": "Event scope (e.g., store/order/created)"
},
"headers": {
"type": "object",
"description": "Custom headers to include"
},
"isActive": {
"type": "boolean",
"description": "Whether webhook is active"
},
"destination": {
"type": "string",
"description": "URL to receive webhook POST"
}
}
}bigcommerce_update_webhookUpdate an existing webhook.
{
"type": "object",
"required": [
"webhookId"
],
"properties": {
"scope": {
"type": "string",
"description": "Event scope"
},
"headers": {
"type": "object",
"description": "Custom headers"
},
"isActive": {
"type": "boolean",
"description": "Whether webhook is active"
},
"webhookId": {
"type": "number",
"description": "Webhook ID to update"
},
"destination": {
"type": "string",
"description": "Destination URL"
}
}
}bigcommerce_delete_webhookDelete a webhook.
{
"type": "object",
"required": [
"webhookId"
],
"properties": {
"webhookId": {
"type": "number",
"description": "Webhook ID to delete"
}
}
}bigcommerce_list_scriptsList scripts installed on the storefront.
Scripts allow injecting custom JavaScript into storefront pages.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"channelId": {
"type": "number",
"description": "Filter by channel ID"
}
}
}bigcommerce_get_scriptGet a single script by UUID.
{
"type": "object",
"required": [
"scriptUuid"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"scriptUuid": {
"type": "string",
"description": "Script UUID"
}
}
}bigcommerce_create_scriptCreate a new storefront script.
Scripts can be injected via HTML or external source URL.
{
"type": "object",
"required": [
"name"
],
"properties": {
"src": {
"type": "string",
"description": "External script URL"
},
"html": {
"type": "string",
"description": "Inline script HTML"
},
"kind": {
"enum": [
"src",
"script_tag"
],
"type": "string",
"description": "Script kind"
},
"name": {
"type": "string",
"description": "Script name"
},
"enabled": {
"type": "boolean",
"description": "Whether script is enabled"
},
"location": {
"enum": [
"head",
"footer"
],
"type": "string",
"description": "Script location"
},
"channelId": {
"type": "number",
"description": "Channel ID"
},
"loadMethod": {
"enum": [
"default",
"async",
"defer"
],
"type": "string",
"description": "Script load method"
},
"visibility": {
"enum": [
"storefront",
"all_pages",
"checkout",
"order_confirmation"
],
"type": "string",
"description": "Page visibility"
},
"description": {
"type": "string",
"description": "Script description"
},
"autoUninstall": {
"type": "boolean",
"description": "Auto-uninstall when app is uninstalled"
},
"consentCategory": {
"enum": [
"essential",
"functional",
"analytics",
"targeting"
],
"type": "string",
"description": "Consent category"
}
}
}bigcommerce_update_scriptUpdate an existing script.
{
"type": "object",
"required": [
"scriptUuid"
],
"properties": {
"src": {
"type": "string",
"description": "External script URL"
},
"html": {
"type": "string",
"description": "Inline script HTML"
},
"kind": {
"enum": [
"src",
"script_tag"
],
"type": "string",
"description": "Script kind"
},
"name": {
"type": "string",
"description": "Script name"
},
"enabled": {
"type": "boolean",
"description": "Whether script is enabled"
},
"location": {
"enum": [
"head",
"footer"
],
"type": "string",
"description": "Script location"
},
"channelId": {
"type": "number",
"description": "Channel ID"
},
"loadMethod": {
"enum": [
"default",
"async",
"defer"
],
"type": "string",
"description": "Load method"
},
"scriptUuid": {
"type": "string",
"description": "Script UUID to update"
},
"visibility": {
"enum": [
"storefront",
"all_pages",
"checkout",
"order_confirmation"
],
"type": "string",
"description": "Visibility"
},
"description": {
"type": "string",
"description": "Script description"
},
"autoUninstall": {
"type": "boolean",
"description": "Auto-uninstall"
},
"consentCategory": {
"enum": [
"essential",
"functional",
"analytics",
"targeting"
],
"type": "string",
"description": "Consent category"
}
}
}bigcommerce_delete_scriptDelete a script from the storefront.
{
"type": "object",
"required": [
"scriptUuid"
],
"properties": {
"scriptUuid": {
"type": "string",
"description": "Script UUID to delete"
}
}
}bigcommerce_list_price_listsList price lists.
Price lists allow different pricing for different customer groups or channels.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_get_price_listGet a single price list by ID.
{
"type": "object",
"required": [
"priceListId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"priceListId": {
"type": "number",
"description": "Price list ID"
}
}
}bigcommerce_create_price_listCreate a new price list.
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Price list name"
},
"active": {
"type": "boolean",
"description": "Whether price list is active"
}
}
}bigcommerce_list_channelsList sales channels.
Channels represent different storefronts or sales platforms.
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"default": 1,
"minimum": 1,
"description": "Page number"
},
"limit": {
"type": "integer",
"default": 50,
"maximum": 250,
"minimum": 1,
"description": "Items per page"
},
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
}
}
}bigcommerce_get_channelGet a single channel by ID.
{
"type": "object",
"required": [
"channelId"
],
"properties": {
"format": {
"enum": [
"json",
"markdown"
],
"type": "string",
"default": "json",
"description": "Response format"
},
"channelId": {
"type": "number",
"description": "Channel ID"
}
}
}