BigCommerce Component

Manage products, brands, categories, and more on the BigCommerce ecommerce platform.

Component key: bigcommerce ·

Description

BigCommerce is a leading SaaS eCommerce platform that allows businesses to build, innovate, and grow their online stores. This component manages products, brands, categories, and other essential e-commerce features in a BigCommerce store.

API Documentation

This component leverages the BigCommerce REST API.

Connections

OAuth 2.0

key: oauth2bigcommerce

To create a connection of type OAuth 2.0:

Prerequisites

A BigCommerce developer account. Sign up at the BigCommerce Developer Portal.
An existing BigCommerce store (or sandbox store) to install the app against.

Setup Steps

Sign in to the BigCommerce Developer Portal and open My Apps.
Click Create an App and complete the app metadata fields.
Under Technical, set the Auth Callback URL to https://oauth2.prismatic.io/callback.
Select the OAuth scopes required by the integration. See the BigCommerce OAuth scopes reference for the full list.
Save the app and note the Client ID and Client Secret values.

Configure the Connection

Enter the OAuth Scopes as a space-delimited list (for example, store_v2_products store_v2_orders). The default is store_v2_default.
Enter the Client ID from the BigCommerce app.
Enter the Client Secret from the BigCommerce app.
Save the connection and complete the OAuth authorization flow when prompted.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for BigCommerce.	https://login.bigcommerce.com/oauth2/authorize
Base URL	The base URL for BigCommerce's API.	https://api.bigcommerce.com
Client ID	The Client ID from the BigCommerce app. Find this in Developer Portal > My Apps > [App] > View Client ID.	abc123def456ghi789jkl012
Client Secret	The Client Secret from the BigCommerce app. Keep this value secure and never share it publicly.
Scopes	Space-delimited list of OAuth scopes. Configure these in the BigCommerce app settings to match required permissions. See BigCommerce OAuth scopes documentation for available scopes.	store_v2_products store_v2_orders
Token URL	The OAuth 2.0 Token URL for BigCommerce.	https://login.bigcommerce.com/oauth2/token

Triggers

New and Updated Orders

Checks for new and updated orders in BigCommerce on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Show New Orders	When enabled, orders created since the last poll will be included in the trigger output.	true
Show Updated Orders	When enabled, orders updated since the last poll will be included in the trigger output.	true
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

The New and Updated Orders polling trigger checks BigCommerce on a configured schedule for orders that were created or modified since the last poll. Unlike webhook-based triggers, polling does not require webhook subscription management and works reliably for low-frequency monitoring scenarios.

How It Works

On each scheduled execution, the trigger:

Reads the last poll timestamp from the polling state (or uses the current execution time on the first run)
Calls the BigCommerce orders endpoint with a min_date_modified filter and page-based pagination, draining all pages of results
Partitions the returned orders into created and updated buckets by comparing each order's date_created against the last poll timestamp: orders created after the cutoff land in created, and all others land in updated
Persists the current execution time as the new last-poll timestamp for the next run
Emits the partitioned results in the trigger payload, filtered by the Show New Orders and Show Updated Orders toggles

If both Show New Orders and Show Updated Orders are disabled, the trigger emits empty arrays for both buckets.

Returned Data

The trigger emits a payload with two arrays, created and updated, each containing order resources returned by BigCommerce.

Example Payload

{
  "data": {
    "created": [
      {
        "id": 101,
        "status": "Pending",
        "status_id": 1,
        "date_created": "Thu, 19 May 2026 14:20:00 +0000",
        "date_modified": "Thu, 19 May 2026 14:25:00 +0000",
        "total_inc_tax": "29.99",
        "currency_code": "USD"
      }
    ],
    "updated": [
      {
        "id": 87,
        "status": "Shipped",
        "status_id": 2,
        "date_created": "Mon, 12 May 2026 09:00:00 +0000",
        "date_modified": "Thu, 19 May 2026 13:15:00 +0000",
        "total_inc_tax": "199.50",
        "currency_code": "USD"
      }
    ]
  }
}

Fields shown are representative. The full response object includes additional properties.

Example Payload for New and Updated Orders⤓

Loading…

Webhook

Receive and validate webhook requests from BigCommerce for manually configured webhook subscriptions. | key: myTrigger

Example Payload for Webhook⤓

Loading…

Data Sources

Select Brands

Select a brand from a specific store. | key: selectBrands | type: picklist

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Select Categories

Select a category from a specific store. | key: selectCategories | type: picklist

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Select Product Modifiers

Select a modifier from a specific product. | key: selectProductModifiers | type: picklist

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Product ID	The unique identifier of the product whose modifier list will be retrieved.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Select Product Variants

Select a variant from a specific product. | key: selectProductVariants | type: picklist

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	A comma-separated list of response fields to omit from each variant object.
Include Fields	A comma-separated list of response fields to keep on each variant object.
Limit	The maximum number of variant records to return per page.	50
Page Number	The 1-based index of the page to retrieve from the paginated variant list.	1
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Select Products

Select a product from a specific store. | key: selectProducts | type: picklist

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Actions

Create Brand

Creates a new brand in the store. | key: createBrand

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand Name	The unique name for the new Brand to be created.	Nike
Image URL	The fully qualified URL of the image displayed for the brand on the storefront.	https://cdn.example.com/images/brand-logo.png
Meta Description	A short SEO summary displayed in search engine results for the brand.	Shop the latest Nike products including shoes, apparel, and accessories.
Meta Keywords	A comma-separated list of meta keywords used in the brand's SEO metadata.
Page Title	The title shown in the browser tab and used as the storefront page heading.	Shop Nike Products
Search Keywords	A comma-separated list of keywords used by the storefront search to match this brand.	athletic, sportswear, running
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Brand⤓

Loading…

Create Brand Image

Uploads an image for a brand. | key: createBrandImage

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID	The unique identifier for the brand to retrieve.	123
Image File	The image file to be uploaded. Must be a valid image format (GIF, JPEG, or PNG).
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Brand Image⤓

Loading…

Create Category

Creates a new category in BigCommerce. | key: createCategory

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Description	The storefront description shown on the category landing page. May include HTML markup.	<p>We offer a wide variety of products perfect for relaxing</p>
Category Name	The display name for the category. Must be unique among its sibling categories.	Bath
Custom URL	The storefront URL path for the category, relative to the store domain.	/bath-products
Default Product Sort	The default ordering applied to products when the category page loads (e.g. use_store_settings, featured, newest).	use_store_settings
Image URL	The fully qualified URL of the image displayed for the brand on the storefront.	https://cdn.example.com/images/brand-logo.png
Is Visible	When true, the category is visible on the storefront. When false, the category is hidden from customers.	false
Layout File	The template filename used to render this category. Relevant for Blueprint themes only.	category.html
Meta Description	A short SEO summary displayed in search engine results for the brand.	Shop the latest Nike products including shoes, apparel, and accessories.
Meta Keywords	A comma-separated list of meta keywords used in the brand's SEO metadata.
Page Title	The title shown in the browser tab and used as the storefront page heading.	Shop Nike Products
Parent ID	The unique identifier of the parent category. Use 0 to create a top-level category.	0
Search Keywords	A comma-separated list of keywords used by the storefront search to match this brand.	athletic, sportswear, running
Sort Order	The display priority for the category in storefront menus. Lower values appear first.	3
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Views	The recorded number of storefront visits to the category page.	1050

Example Payload for Create Category⤓

Loading…

Create Category Image

Uploads an image for a specific category. | key: createCategoryImage

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	The unique identifier for the category to operate on.	39
Image File	The image file to be uploaded. Must be a valid image format (GIF, JPEG, or PNG).
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Category Image⤓

Loading…

Create Category Tree

Creates a new category tree in BigCommerce. | key: createCategoryTree

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Name	The display name shown for the category on the storefront and admin panel.	Garden
Parent ID	Set to 0 for top level category. Otherwise, set to the ID of the parent category.	0
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Category Tree⤓

Loading…

Create Custom Field

Creates a custom field for a product. | key: createCustomField

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Custom Field Name	The display name (key) for the custom field attached to the product.	warranty_months
Custom Field Value	The value stored under the custom field key on the product.	12
Product ID	The unique identifier of the product whose custom fields will be retrieved.	105
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Custom Field⤓

Loading…

Create Modifier Image

Creates an image for a product modifier value. | key: createModifierImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Modifier Image File	The image file (GIF, JPEG, or PNG) to upload and associate with the modifier option value.
Modifier ID	The unique identifier of the modifier record to retrieve.	12
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Modifier Value ID	The unique identifier of the modifier option value to attach the uploaded image to.	21

Example Payload for Create Modifier Image⤓

Loading…

Create Product

Creates a new product in the store. | key: createProduct

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Cost Price	The merchant cost of acquiring the product. Stored for internal reporting only and not shown to customers.	15.00
Product Depth	The physical depth used by shipping calculators, expressed in the store's configured length unit.	2
Product Description	The storefront description for the product. May include HTML markup for formatting.	<p>100% cotton t-shirt with comfortable fit</p>
Product Height	The physical height used by shipping calculators, expressed in the store's configured length unit.	12
Product Name	A unique storefront name for the product. Must be 1 to 250 characters.	Premium Cotton T-Shirt
Product Price	The listed selling price of the product. Whether tax is included depends on the store's tax settings.	29.99
Product SKU	A user-defined alphanumeric stock-keeping unit code, unique within the store. Length 0 to 255 characters.	TSHIRT-BLUE-M
Product Type	The fulfillment type for the product. Must be either 'physical' or 'digital'.	physical
Product Weight	The shipping weight of the product, expressed in the store's configured weight unit.	0.5
Product Width	The physical width used by shipping calculators, expressed in the store's configured length unit.	10
Retail Price	The manufacturer's suggested retail price. When set, this value is displayed alongside the selling price on the product page.	39.99
Sale Price	An override price used in place of the regular price for promotional pricing calculations.	24.99

Example Payload for Create Product⤓

Loading…

Create Product Image

Creates a product image. | key: createProductImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Image File	The local path to the source image file to upload. Sent as multipart/form-data.	/tmp/product-photo.jpg
Image URL	The fully qualified URL of a remote image file to fetch and attach to the product. Maximum file size is 8MB.	https://cdn.example.com/images/product.png
Product ID	The unique numeric identifier for the product the new image will be attached to.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Product Image⤓

Loading…

Create Product Modifier

Creates a product modifier. | key: createProductModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Configuration	A JSON object containing type-specific configuration values for the modifier (e.g. default values, min/max, format).	`{ "default_value": "", "checked_by_default": false }`
Display Name	The label shown to shoppers on the storefront when this modifier is rendered.	Choose Size
Option Values	A JSON array of selectable option values offered by this modifier. Used for dropdown, radio, rectangle, and swatch types.	`[ { "label": "Small", "sort_order": 1, "is_default": true } ]`
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Required	When true, the shopper must select or fill in this modifier before checkout is allowed.	false
Sort Order	The display position for this modifier on the product detail page. Lower values appear first.	1
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Modifier Type	The input control type for the modifier. Acceptable values include date, checkbox, dropdown, radio_buttons, rectangles, swatch, product_list, file, text, multi_line_text, numbers_only_text.	dropdown

Example Payload for Create Product Modifier⤓

Loading…

Create Product Variant

Creates a new product variant in BigCommerce. | key: createProductVariantAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Variant Depth	The physical depth specific to this variant, expressed in the store's configured length unit.	2
Variant Height	The physical height specific to this variant, expressed in the store's configured length unit.	12
Option Values	A JSON array of option/option-value ID pairs that together define this variant's attribute combination.	`[ { "id": 0, "option_id": 0, "option_display_name": "string", "label": "string" } ]`
Variant Price	The storefront selling price specific to this variant, overriding the parent product price.	29.99
Product ID	The unique identifier of the parent product that owns the resource being operated on.	102
Variant SKU	The stock-keeping unit code for the variant. Must be between 1 and 255 characters and unique within the store.	TSHIRT-BLUE-M
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant Weight	The shipping weight specific to this variant, expressed in the store's configured weight unit.	0.5
Variant Width	The physical width specific to this variant, expressed in the store's configured length unit.	10

Example Payload for Create Product Variant⤓

Loading…

Create Variant Image

Creates or updates an image for a specific product variant. | key: createVariantImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Image URL	The fully qualified URL of a remote image (GIF, JPEG, or PNG) to assign to this variant.	https://cdn.example.com/images/variant.png
Product ID	The unique identifier of the parent product that owns the resource being operated on.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant ID	The unique identifier of the variant being retrieved, either on a product or an associated Price List Record.	201

Example Payload for Create Variant Image⤓

Loading…

Create Webhook

Creates a new webhook in BigCommerce. | key: createWebhookAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Destination	The fully qualified HTTPS URL that BigCommerce will POST webhook events to.	https://example.com/webhooks/bigcommerce
Events History Enabled (Deprecated)	Deprecated: when true, events that fail to deliver are retained for later replay.	false
Headers	A JSON object of custom HTTP headers that BigCommerce will include on every webhook delivery request.	`{ "Custom-Header-1": "Value1", "Custom-Header-2": "Value2" }`
Is Active	When true, restricts the result to webhooks that are currently enabled. When false, restricts to disabled webhooks.	false
Scope	The BigCommerce event scope that the webhook subscribes to (e.g. store/order/created).	store/order/created
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Create Webhook⤓

Loading…

Delete Brand

Deletes a brand by ID. | key: deleteBrand

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID to Delete	The unique identifier of the brand to permanently remove.	789
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Brand⤓

Loading…

Delete Brand Image

Deletes an image for a brand by ID. | key: deleteBrandImage

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID	The unique identifier for the brand to retrieve.	123
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Brand Image⤓

Loading…

Delete Categories

Deletes categories based on provided filters. | key: deleteCategories

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID	Restrict results to the item that has this exact numeric ID.	39
ID Greater Than	Return only items whose ID is strictly greater than the specified value.	50
ID In	Restrict results to items whose ID appears in this comma-separated list.
ID Less Than	Return only items whose ID is strictly less than the specified value.	75
ID Max	Upper bound (inclusive) on the item ID. Items with larger IDs are excluded.	100
ID Min	Lower bound (inclusive) on the item ID. Items with smaller IDs are excluded.	10
ID Not In	Exclude any item whose ID appears in this comma-separated list of values.
Is Visible	When true, the category is visible on the storefront. When false, the category is hidden from customers.	false
Keyword	Free-text search term matched against item names, descriptions, and search keywords.
Name	Restrict results to items whose name matches this value exactly.
Name Contains	Substring used to perform a partial, case-insensitive match against item names.
Page Title	The title shown in the browser tab and used as the storefront page heading.	Shop Nike Products
Page Title Like	Substring used to perform a partial match against category page titles.	Bath
Parent ID Greater Than	Return only items whose parent ID is strictly greater than the specified value.	20
Parent ID In	Restrict results to items whose parent ID appears in this comma-separated list.
Parent ID Less Than	Return only items whose parent ID is strictly less than the specified value.	30
Parent ID Max	Upper bound (inclusive) on the parent ID. Items with larger parent IDs are excluded.	50
Parent ID Min	Lower bound (inclusive) on the parent ID. Items with smaller parent IDs are excluded.	5
Parent ID	The unique identifier of the parent category. Use 0 to create a top-level category.	0
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Categories⤓

Loading…

Delete Categories from Tree

Deletes specified categories from a category tree in BigCommerce. | key: deleteCategoriesTree

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	The numeric identifier for the category targeted by this request.	45
Category UUID	The UUID-formatted unique identifier for the category. Used as an alternative to numeric category IDs.	550e8400-e29b-41d4-a716-446655440000
Parent ID	Restrict results to items whose immediate parent has this numeric ID.	19
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Tree ID	The unique identifier of the category tree to operate on.	1

Example Payload for Delete Categories from Tree⤓

Loading…

Delete Category Image

Deletes an image associated with a given category. | key: deleteCategoryImage

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	The unique identifier for the category to operate on.	39
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Category Image⤓

Loading…

Delete Category Trees

Deletes specific category trees. | key: deleteCategoryTrees

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID In	A comma-separated list of category IDs to restrict the result set to.	39,40,41
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Category Trees⤓

Loading…

Delete Custom Field

Deletes a product custom field. | key: deleteCustomField

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Custom Field ID to Delete	The unique identifier of the custom field record to permanently remove.	8
Product ID	The unique identifier of the product whose custom fields will be retrieved.	105
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Custom Field⤓

Loading…

Delete Instanced Webhooks

Deletes all webhooks that point to a flow in this instance. | key: deleteInstancedWebhooksAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Destination	The fully qualified HTTPS URL that BigCommerce will POST webhook events to.	https://example.com/webhooks/bigcommerce
Instance URL Pattern	A substring or pattern compared against webhook destination URLs to select which webhooks to operate on.	example.com/webhooks
Is Active	When true, restricts the result to webhooks that are currently enabled. When false, restricts to disabled webhooks.	false
Items Per Page	The maximum number of webhook records to return per page.	50
Page Number	The 1-based index of the page to retrieve from the paginated webhook list.	1
Scope	The BigCommerce event scope that the webhook subscribes to (e.g. store/order/created).	store/order/created
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Instanced Webhooks⤓

Loading…

Delete Product

Deletes a product. | key: deleteProduct

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Product ID to Delete	The unique identifier of the product to permanently remove.	103
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Product⤓

Loading…

Delete Product Image

Deletes a product image. | key: deleteProductImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Image ID to Delete	The unique identifier of the image record to permanently remove.	55
Product ID	The unique identifier of the product that owns the image being deleted.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Product Image⤓

Loading…

Delete Product Modifier

Deletes a product modifier. | key: deleteProductModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Modifier ID	The unique identifier of the modifier record to retrieve.	12
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Delete Product Modifier⤓

Loading…

Delete Product Variant

Deletes a specific product variant. | key: deleteProductVariantAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Product ID	The unique identifier of the parent product that owns the resource being operated on.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant ID	The unique identifier of the variant being retrieved, either on a product or an associated Price List Record.	201

Example Payload for Delete Product Variant⤓

Loading…

Delete Webhook

Deletes a specific webhook from BigCommerce. | key: deleteWebhookAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Webhook ID	The unique identifier of the webhook record being modified.	12345

Example Payload for Delete Webhook⤓

Loading…

Get Brand

Retrieves details of a specific brand. | key: getBrand

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID	The unique identifier for the brand to retrieve.	123
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Get Brand⤓

Loading…

Get Catalog Summary

Returns a lightweight inventory summary from the BigCommerce Catalog. | key: getCatalogSummaryAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Get Catalog Summary⤓

Loading…

Get Category

Returns a single category. | key: getCategory

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	The unique identifier for the category to operate on.	39
Exclude Fields	A comma-separated list of response fields to omit. The ID cannot be excluded.
Include Fields	A comma-separated list of response fields to keep. The ID is always returned.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Get Category⤓

Loading…

Get Category Tree

Returns a category tree. | key: getCategoryTree

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Depth	The maximum number of nesting levels to traverse when fetching the category tree.	3
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Tree ID	The unique identifier of the category tree to operate on.	1

Example Payload for Get Category Tree⤓

Loading…

Get Product Custom Fields

Returns a list of product custom fields. | key: getProductCustomFields

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Limit	The maximum number of results to return per page.
Page	The 1-based index of the page to retrieve from the paginated result set.
Product ID	The unique identifier of the product whose custom fields will be retrieved.	105
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Get Product Custom Fields⤓

Loading…

Get Product Image

Returns a single product image. | key: getProductImage

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Image ID	The unique identifier of the specific image record to retrieve.	55
Product ID for Image	The unique identifier of the product that owns the image being retrieved.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Get Product Image⤓

Loading…

Get Product Modifier

Returns a single product modifier. | key: getModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	A comma-separated list of response fields to omit. The ID cannot be excluded.
Include Fields	A comma-separated list of response fields to keep on each modifier object.
Modifier ID	The unique identifier of the modifier record to retrieve.	12
Product ID	The unique identifier of the product that owns the modifier being retrieved.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Get Product Modifier⤓

Loading…

Get Product Variant

Returns a specific product variant. | key: getProductVariantAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	A comma-separated list of response fields to omit from each variant object.
Include Fields	A comma-separated list of response fields to keep on each variant object.
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant ID	The unique identifier of the variant being retrieved, either on a product or an associated Price List Record.	201

Example Payload for Get Product Variant⤓

Loading…

List Brands

Returns a list of all of the store's brands. | key: listBrands

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand Name	Restrict the brand list to entries whose name matches this value.	Apple
Limit	The maximum number of results to return per page.	50
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Brands⤓

Loading…

List Categories

Returns a list of categories with optional filters. | key: getAllCategories

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	A comma-separated list of response fields to omit. The ID cannot be excluded.
ID	Restrict results to the item that has this exact numeric ID.	39
ID Greater Than	Return only items whose ID is strictly greater than the specified value.	50
ID In	Restrict results to items whose ID appears in this comma-separated list.
ID Less Than	Return only items whose ID is strictly less than the specified value.	75
ID Max	Upper bound (inclusive) on the item ID. Items with larger IDs are excluded.	100
ID Min	Lower bound (inclusive) on the item ID. Items with smaller IDs are excluded.	10
ID Not In	Exclude any item whose ID appears in this comma-separated list of values.
Include Fields	A comma-separated list of response fields to keep. The ID is always returned.
Is Visible	When true, returns only items visible on the storefront. When false, returns only hidden items.	false
Keyword	Free-text search term matched against item names, descriptions, and search keywords.
Limit	The maximum number of results to return per page.
Name	Restrict results to items whose name matches this value exactly.
Name Contains	Substring used to perform a partial, case-insensitive match against item names.
Page	The 1-based index of the page to retrieve from the paginated result set.
Page Title	Restrict results to items whose storefront page title matches this value exactly.
Page Title Contains	Substring used to perform a partial match against storefront page titles.
Parent ID	Restrict results to items whose immediate parent has this numeric ID.	19
Parent ID Greater Than	Return only items whose parent ID is strictly greater than the specified value.	20
Parent ID In	Restrict results to items whose parent ID appears in this comma-separated list.
Parent ID Less Than	Return only items whose parent ID is strictly less than the specified value.	30
Parent ID Max	Upper bound (inclusive) on the parent ID. Items with larger parent IDs are excluded.	50
Parent ID Min	Lower bound (inclusive) on the parent ID. Items with smaller parent IDs are excluded.	5
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Categories⤓

Loading…

List Categories (Simplified)

Returns a list of categories. | key: getAllCategoriesSimple

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID In	A comma-separated list of category IDs to restrict the result set to.	39,40,41
Limit	The maximum number of results to return per page.
Page	The 1-based index of the page to retrieve from the paginated result set.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Categories (Simplified)⤓

Loading…

List Category Trees

Returns a list of category trees. | key: getAllCategoryTrees

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID In	A comma-separated list of category IDs to restrict the result set to.	39,40,41
Channel ID In	A comma-separated list of channel IDs used to restrict results to specific storefront channels.	1,2,3
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Category Trees⤓

Loading…

List Product Images

Returns a list of product images with optional filter parameters. | key: getAllProductImages

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Product ID for Images	The unique identifier of the product whose image collection will be retrieved.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Product Images⤓

Loading…

List Product Modifiers

Returns a list of all product modifiers. | key: getAllProductModifiersAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	A comma-separated list of response fields to omit. The ID cannot be excluded.
Include Fields	A comma-separated list of response fields to keep on each modifier object.
Limit	The maximum number of modifier records to return per page.	50
Page	The 1-based index of the page to retrieve from the paginated modifier list.	1
Product ID	The unique identifier of the product whose modifier list will be retrieved.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Product Modifiers⤓

Loading…

List Product Variants

Returns a list of product variants. | key: getAllProductVariantsAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	A comma-separated list of response fields to omit from each variant object.
Include Fields	A comma-separated list of response fields to keep on each variant object.
Limit	The maximum number of variant records to return per page.	50
Page Number	The 1-based index of the page to retrieve from the paginated variant list.	1
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Product Variants⤓

Loading…

List Products

Returns a list of products with optional filter parameters. | key: getAllProducts

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID	Restrict results to products belonging to the brand with this ID.	456
Product ID	The unique identifier for the product. When used as a filter, only matching products are returned.	102
Limit	The maximum number of products to return per page.	50
Product Name	Restrict results to products whose name matches this value.	Blue T-Shirt
Page	The 1-based index of the page to retrieve from the paginated product list.	1
Product Price	Restrict results to products whose listed price equals this value.	29.99
Product Type	Restrict results to products of the given type (e.g. physical or digital).	physical
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Products⤓

Loading…

List Webhooks

Returns a list of all webhooks on a store. | key: getWebhooksAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Destination	The fully qualified HTTPS URL that BigCommerce will POST webhook events to.	https://example.com/webhooks/bigcommerce
Is Active	When true, restricts the result to webhooks that are currently enabled. When false, restricts to disabled webhooks.	false
Items Per Page	The maximum number of webhook records to return per page.	50
Page Number	The 1-based index of the page to retrieve from the paginated webhook list.	1
Scope	The BigCommerce event scope that the webhook subscribes to (e.g. store/order/created).	store/order/created
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for List Webhooks⤓

Loading…

Raw Request

Sends a raw HTTP request to BigCommerce. | key: rawRequest

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Timeout	The maximum time that a client will await a response to its request	2000
URL	This is the URL to call.	/v3/catalog/brands
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Example Payload for Raw Request⤓

Loading…

Update Brand

Updates a brand's details. | key: updateBrand

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID to Update	The unique identifier of the brand being modified.	456
New Brand Name	The replacement display name to assign to the brand.	Nike Sportswear
New Image URL	The replacement fully qualified URL of the image displayed for the brand.	https://cdn.example.com/images/new-brand-logo.png
New Page Title	The replacement browser tab title and storefront heading for the brand page.	Nike Sportswear Collection
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Update Brand⤓

Loading…

Update Categories

Updates existing categories in BigCommerce. | key: updateCategories

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	The unique identifier of the category being updated.	42
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Tree ID	The unique identifier of the category tree being updated.	2

Example Payload for Update Categories⤓

Loading…

Update Category

Updates an existing category in BigCommerce. | key: updateCategory

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Description	The storefront description shown on the category landing page. May include HTML markup.	<p>We offer a wide variety of products perfect for relaxing</p>
Category ID	The unique identifier for the category to operate on.	39
Category Name	The display name for the category. Must be unique among its sibling categories.	Bath
Custom URL	The storefront URL path for the category, relative to the store domain.	/bath-products
Default Product Sort	The default ordering applied to products when the category page loads (e.g. use_store_settings, featured, newest).	use_store_settings
Image URL	The fully qualified URL of the image displayed for the brand on the storefront.	https://cdn.example.com/images/brand-logo.png
Is Visible	When true, the category is visible on the storefront. When false, the category is hidden from customers.	false
Layout File	The template filename used to render this category. Relevant for Blueprint themes only.	category.html
Meta Description	A short SEO summary displayed in search engine results for the brand.	Shop the latest Nike products including shoes, apparel, and accessories.
Meta Keywords	A comma-separated list of meta keywords used in the brand's SEO metadata.
Page Title	The title shown in the browser tab and used as the storefront page heading.	Shop Nike Products
Parent ID	The unique identifier of the parent category. Use 0 to create a top-level category.	0
Search Keywords	A comma-separated list of keywords used by the storefront search to match this brand.	athletic, sportswear, running
Sort Order	The display priority for the category in storefront menus. Lower values appear first.	3
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Views	The recorded number of storefront visits to the category page.	1050

Example Payload for Update Category⤓

Loading…

Update Custom Field

Updates a custom field for a product. | key: updateCustomField

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Custom Field ID to Update	The unique identifier of the custom field record being modified.	7
Custom Field Name	The display name (key) for the custom field attached to the product.	warranty_months
Custom Field Value	The value stored under the custom field key on the product.	12
Product ID	The unique identifier of the product whose custom fields will be retrieved.	105
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Update Custom Field⤓

Loading…

Update Product

Updates a product in the catalog. | key: updateProduct

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Product ID	The unique identifier for the product. When used as a filter, only matching products are returned.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Cost Price	The merchant cost of acquiring the product. Stored for internal reporting only and not shown to customers.	15.00
Product Depth	The physical depth used by shipping calculators, expressed in the store's configured length unit.	2
Product Height	The physical height used by shipping calculators, expressed in the store's configured length unit.	12
Product Name	A unique storefront name for the product. Must be 1 to 250 characters.	Premium Cotton T-Shirt
Product Price	The listed selling price of the product. Whether tax is included depends on the store's tax settings.	29.99
Product Type	The fulfillment type for the product. Must be either 'physical' or 'digital'.	physical
Product Weight	The shipping weight of the product, expressed in the store's configured weight unit.	0.5
Product Width	The physical width used by shipping calculators, expressed in the store's configured length unit.	10
Retail Price	The manufacturer's suggested retail price. When set, this value is displayed alongside the selling price on the product page.	39.99
Sale Price	An override price used in place of the regular price for promotional pricing calculations.	24.99

Example Payload for Update Product⤓

Loading…

Update Product Image

Updates a product image. | key: updateProductImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Image Description	Alternative text and caption used by the storefront and assistive technologies for this image.	Front view of the blue cotton t-shirt
Image File	The local path to a replacement image file to upload via multipart/form-data.	/tmp/replacement-photo.jpg
Image ID to Update	The unique identifier of the image record to modify.	55
Image URL	The fully qualified URL of a remote image to use as the new source for this image record. Must include protocol.	https://cdn.example.com/images/product-v2.png
Is Thumbnail	When true, marks this image as the product's primary thumbnail shown in listings.	false
Product ID for Image	The unique identifier of the product that owns the image being updated.	102
Sort Order	The display position for this image within the product gallery. Lower values appear first.	1
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Standard Image URL	The fully qualified URL for the standard-resolution image shown on product detail pages.	https://cdn.example.com/images/product-standard.png
Thumbnail Image URL	The fully qualified URL for the small thumbnail used in category and search listings.	https://cdn.example.com/images/product-thumb.png
Tiny Image URL	The fully qualified URL for the tiny image used in cart and minimal-space contexts.	https://cdn.example.com/images/product-tiny.png
Zoom Image URL	The fully qualified URL for the high-resolution zoom variant displayed on hover.	https://cdn.example.com/images/product-zoom.png

Example Payload for Update Product Image⤓

Loading…

Update Product Modifier

Updates a product modifier. | key: updateProductModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Configuration	A JSON object containing type-specific configuration values for the modifier (e.g. default values, min/max, format).	`{ "default_value": "", "checked_by_default": false }`
Display Name	The label shown to shoppers on the storefront when this modifier is rendered.	Choose Size
Modifier ID	The unique identifier of the modifier record to retrieve.	12
Option Values	A JSON array of selectable option values offered by this modifier. Used for dropdown, radio, rectangle, and swatch types.	`[ { "label": "Small", "sort_order": 1, "is_default": true } ]`
Product ID	The unique identifier of the product the new modifier will be attached to.	102
Required	When true, the shopper must select or fill in this modifier before checkout is allowed.	false
Sort Order	The display position for this modifier on the product detail page. Lower values appear first.	1
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Modifier Type	The input control type for the modifier. Acceptable values include date, checkbox, dropdown, radio_buttons, rectangles, swatch, product_list, file, text, multi_line_text, numbers_only_text.	dropdown

Example Payload for Update Product Modifier⤓

Loading…

Update Product Variant

Updates a specific product variant. | key: updateProductVariantAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Variant Depth	The physical depth specific to this variant, expressed in the store's configured length unit.	2
Variant Height	The physical height specific to this variant, expressed in the store's configured length unit.	12
Option Values	A JSON array of option/option-value ID pairs that together define this variant's attribute combination.	`[ { "id": 0, "option_id": 0, "option_display_name": "string", "label": "string" } ]`
Variant Price	The storefront selling price specific to this variant, overriding the parent product price.	29.99
Product ID	The unique identifier of the parent product that owns the resource being operated on.	102
Variant SKU	The stock-keeping unit code for the variant. Must be between 1 and 255 characters and unique within the store.	TSHIRT-BLUE-M
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant ID	The unique identifier of the variant being retrieved, either on a product or an associated Price List Record.	201
Variant Weight	The shipping weight specific to this variant, expressed in the store's configured weight unit.	0.5
Variant Width	The physical width specific to this variant, expressed in the store's configured length unit.	10

Example Payload for Update Product Variant⤓

Loading…

Update Products (Batch)

Updates products in batches. | key: updateProductsBatch

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Products (Batch)	A JSON array of product objects to upsert in a single batch operation. Each object must include the product ID and any fields to update.	`[ { "id": 0, "name": "string", "type": "physical", "sku": "string", "description": "string", "weight": 0, "width": 0, "depth": 0, "height": 0, "price": 0, "cost_price": 0, "retail_price": 0, "sale_price": 0, "map_price": 0, "tax_class_id": 0, "product_tax_code": "string", "categories": [], "brand_id": 0, "brand_name": "string", "inventory_level": 0, "inventory_warning_level": 0 } ]`

Example Payload for Update Products (Batch)⤓

Loading…

Update Webhook

Updates an existing webhook in BigCommerce. | key: updateWebhookAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Destination	The fully qualified HTTPS URL that BigCommerce will POST webhook events to.	https://example.com/webhooks/bigcommerce
Headers	A JSON object of custom HTTP headers that BigCommerce will include on every webhook delivery request.	`{ "Custom-Header-1": "Value1", "Custom-Header-2": "Value2" }`
Is Active	When true, restricts the result to webhooks that are currently enabled. When false, restricts to disabled webhooks.	false
Scope	The BigCommerce event scope that the webhook subscribes to (e.g. store/order/created).	store/order/created
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Webhook ID	The unique identifier of the webhook record being modified.	12345

Example Payload for Update Webhook⤓

Loading…

Upsert Category Trees

Upserts Category Trees. This single endpoint updates and creates category trees. | key: upsertCategoryTrees

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Tree Data	A JSON array of category tree objects to upsert. Each object must include name and channel_ids.	`{ "id": 0, "name": "string", "channel_ids": [ 0 ] }`
Store Hash	The unique identifier for the BigCommerce store. Find this in the store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Example Payload for Upsert Category Trees⤓

Loading…

Changelog

2026-05-26

Added the New and Updated Orders polling trigger that monitors orders in BigCommerce on a configured schedule using the min_date_modified filter on GET /v2/orders. Results are partitioned into created and updated buckets based on each order's date_created timestamp

2026-05-14

Added bulk pagination support to list actions across brands, categories, categories tree, custom fields, product images, products, product modifiers, product variants, and webhooks, allowing users to fetch all pages of results in a single action invocation

2026-04-30

Updated spectral version

2026-04-07

Added global debug support across all actions for improved troubleshooting

2026-03-31

Various modernizations and documentation updates

2025-07-29

Renamed delete tree categories action for improved clarity and consistency

Manage products, brands, categories, and more on the BigCommerce ecommerce platform.

Description​

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

New and Updated Orders​

How It Works​

Returned Data​

Webhook​

Data Sources​

Select Brands​

Select Categories​

Select Product Modifiers​

Select Product Variants​

Select Products​

Actions​

Create Brand​

Create Brand Image​

Create Category​

Create Category Image​

Create Category Tree​

Create Custom Field​

Create Modifier Image​

Create Product​

Create Product Image​

Create Product Modifier​

Create Product Variant​

Create Variant Image​

Create Webhook​

Delete Brand​

Delete Brand Image​

Delete Categories​

Delete Categories from Tree​

Delete Category Image​

Delete Category Trees​

Delete Custom Field​

Delete Instanced Webhooks​

Delete Product​

Delete Product Image​

Delete Product Modifier​

Delete Product Variant​

Delete Webhook​

Get Brand​

Get Catalog Summary​

Get Category​

Get Category Tree​

Get Product Custom Fields​

Get Product Image​

Get Product Modifier​

Get Product Variant​

List Brands​

List Categories​

List Categories (Simplified)​

List Category Trees​

List Product Images​

List Product Modifiers​

List Product Variants​

List Products​

List Webhooks​

Raw Request​

Update Brand​

Update Categories​

Update Category​

Update Custom Field​

Update Product​

Update Product Image​

Update Product Modifier​

Update Product Variant​

Update Products (Batch)​

Update Webhook​

Upsert Category Trees​

Changelog​

2026-05-26​

2026-05-14​

2026-04-30​

2026-04-07​

Description

API Documentation

Connections

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Triggers

New and Updated Orders

How It Works

Returned Data

Webhook

Data Sources

Select Brands

Select Categories

Select Product Modifiers

Select Product Variants

Select Products

Actions

Create Brand

Create Brand Image

Create Category

Create Category Image

Create Category Tree

Create Custom Field

Create Modifier Image

Create Product

Create Product Image

Create Product Modifier

Create Product Variant

Create Variant Image

Create Webhook

Delete Brand

Delete Brand Image

Delete Categories

Delete Categories from Tree

Delete Category Image

Delete Category Trees

Delete Custom Field

Delete Instanced Webhooks

Delete Product

Delete Product Image

Delete Product Modifier

Delete Product Variant

Delete Webhook

Get Brand

Get Catalog Summary

Get Category

Get Category Tree

Get Product Custom Fields

Get Product Image

Get Product Modifier

Get Product Variant

List Brands

List Categories

List Categories (Simplified)

List Category Trees

List Product Images

List Product Modifiers

List Product Variants

List Products

List Webhooks

Raw Request

Update Brand

Update Categories

Update Category

Update Custom Field

Update Product

Update Product Image

Update Product Modifier

Update Product Variant

Update Products (Batch)

Update Webhook

Upsert Category Trees

Changelog

2026-05-26

2026-05-14

2026-04-30

2026-04-07

2026-03-31