BigCommerce Component

BigCommerce is a SaaS ecommerce platform. Use the Bigcommerce component to manage your Products, Brands, Categories and more.

Component key: bigcommerce

Description

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

Connections

BigCommerce OAuth 2.0

1. To create an OAuth 2.0 app in BigCommerce, sign up for a BigCommerce developer account at https://developer.bigcommerce.com/ and create a new BigCommerce application.
2. Take note of your application's Client ID and Secret and enter those values in Prismatic when you add a BigCommerce connection to your integration.
3. Under Redirect URI, add Prismatic's callback URL, https://oauth2.prismatic.io/callback.

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://login.bigcommerce.com/oauth2/authorize	The OAuth 2.0 Authorization URL for BigCommerce
Base URL string / Required Hidden Field baseUrl	https://api.bigcommerce.com	The base URL for BigCommerce's API
Client ID string / Required clientId
Client Secret password / Required clientSecret
Scopes string / Required scopes	store_v2_default	A space-delimited set of one or more scopes to get the user's permission to access.
Token URL string / Required Hidden Field tokenUrl	https://login.bigcommerce.com/oauth2/token	The OAuth 2.0 Token URL for BigCommerce

Triggers

Webhook

Receive and validate webhook requests from BigCommerce for webhooks you configure. | key: myTrigger

---

Data Sources

Select Brands

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Select Categories

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Select Product Modifiers

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Product ID string / Required product_id	The ID of the Product to which the modifiers belong.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Select Product Variants

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Exclude Fields text exclude_fields	Fields to exclude, in a comma-separated list.
Include Fields text include_fields	Fields to include, in a comma-separated list.
Limit text limit	Controls the number of items per page in a limited (paginated) list of products.
Page Number text page	Specifies the page number in a limited (paginated) list of products.
Product ID text / Required product_id	The ID of the Product to which the modifier will be added.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Select Products

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Actions

Create a Category Image

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category ID string / Required categoryId	The ID of the category to retrieve.
Image File data / Required imageFile	The image file to be uploaded.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Create a Category Tree

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category Name string / Required categoryNameTree	The name displayed for the category.
Parent ID string / Required parent_id_Tree	Set to 0 for top level category. Otherwise, set to the ID of the parent category.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Create a Product Modifier

Creates a Product Modifier. | key: createProductModifierAction

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Configuration code config		The configuration values for the modifier.
Display Name text / Required display_name		The name of the option shown on the storefront.
Option Values code option_values		The option values for the modifier.
Product ID text / Required product_id		The ID of the Product to which the modifier will be added.
Required boolean / Required required	false	Whether or not this modifier is required at checkout.
Sort Order text sort_order		The order the modifiers display on the product detail page.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Modifier Type text / Required type		The type of the modifier. Acceptable values: date, checkbox, etc.

---

Create a Product Variant

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Variant Depth text / Required depth	Depth of the variant.
Variant Height text / Required height	Height of the variant.
Option Values code / Required option_values	Array of option and option values IDs that make up this variant.
Variant Price text / Required price	This variants base price on the storefront.
Product ID string / Required product_id	The ID of the Product to which the resource belongs.
Variant SKU text / Required sku	SKU for the variant. Must be between 1 and 255 characters.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Variant Weight text / Required weight	This variants base weight on the storefront.
Variant Width text / Required width	Width of the variant.

---

Create a Variant Image

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Image URL string image_url
Product ID string / Required product_id	The ID of the Product to which the resource belongs.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Variant ID text / Required variant_id	ID of the variant on a product, or on an associated Price List Record.

---

Create a Webhook

Creates a new webhook in BigCommerce. | key: createWebhookAction

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Destination string destination
Events History Enabled (Deprecated) boolean events_history_enabled
Headers code headers
Is Active boolean is_active	false
Scope string scope
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.

---

Create Brand

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand Name string / Required brandNameToCreate	The unique name for the new Brand to be created.
Image URL string imageUrl
Meta Description string metaDescription
Meta Keywords string metaKeywords	Comma-separated list of meta keywords.
Page Title string pageTitle
Search Keywords string searchKeywords
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Create Brand Image

Upload an image for a brand. | key: createBrandImage

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand ID string brandId	Filter brands by ID.
Image File data / Required imageFile	The image file to be uploaded.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Create Category

Creates a new category in BigCommerce. | key: createCategory

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category Description text categoryDescription		Description for the category, can include HTML.
Category Name string / Required categoryName		Name of the category. It should be unique among its siblings.
Custom URL text customUrl		Custom URL for the category on the storefront.
Default Product Sort string defaultProductSort		Determines how products are sorted on category page load.
Image URL string imageUrl
Is Visible boolean isVisible	false	Flag to determine if the category is visible on the storefront.
Layout File string layoutFile		Layout file for the category. Relevant for Blueprint themes.
Meta Description string metaDescription
Meta Keywords string metaKeywords		Comma-separated list of meta keywords.
Page Title string pageTitle
Parent ID string / Required parentId		ID of the parent category. Set to 0 for top-level category.
Search Keywords string searchKeywords
Sort Order string sortOrder		Priority of this category in the menu and category pages.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Views string views		Number of views the category has on the storefront.

---

Create Custom Field

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Custom Field Name string / Required customFieldName	The name of the custom field.
Custom Field Value string / Required customFieldValue	The value of the custom field.
Product ID string / Required productCustomFieldsProductId	The ID of the Product to retrieve custom fields for.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Create Modifier Image

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Modifier Image File data / Required image_file	The image file to upload for the modifier.
Modifier ID string / Required modifier_id	The ID of the Modifier.
Product ID text / Required product_id	The ID of the Product to which the modifier will be added.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Modifier Value ID text / Required value_id	The ID of the Modifier Value.

---

Create Product

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Cost Price text uniqueCostPrice	The cost price of the product. Stored for reference only.
Product Depth text uniqueProductDepth	Depth of the product, which can be used when calculating shipping costs.
Product Description text uniqueProductDescription	The product description, which can include HTML formatting.
Product Height text uniqueProductHeight	Height of the product, which can be used when calculating shipping costs.
Product Name text / Required uniqueProductName	A unique product name. Length between 1 to 250 characters.
Product Price text / Required uniqueProductPrice	The price of the product. The price should include or exclude tax, based on the store settings.
Product SKU text uniqueProductSku	A unique user-defined alphanumeric product code/stock keeping unit (SKU). Length between 0 to 255 characters.
Product Type text / Required uniqueProductType	The product type. Either 'physical' or 'digital'.
Product Weight text / Required uniqueProductWeight	Weight of the product. This is based on the unit set on the store.
Product Width text uniqueProductWidth	Width of the product, which can be used when calculating shipping costs.
Retail Price text uniqueRetailPrice	The retail cost of the product. If entered, the retail cost price will be shown on the product page.
Sale Price text uniqueSalePrice	If entered, the sale price will be used instead of value in the price field when calculating the product's cost.

---

Create Product Image

Creates a Product Image. | key: createProductImageAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Image File string / Required image_file	The local path to the original image file uploaded to BigCommerce. A multipart/form-data media type.
Image URL string image_url	The fully qualified URL path of the image. Limit of 8MB per file.
Product ID string / Required product_id	The unique numeric identifier for the product with which the image is associated.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete a Category Image

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category ID string / Required categoryId	The ID of the category to retrieve.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete a Custom Field

Deletes a product custom field. | key: deleteCustomField

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Custom Field ID to Delete string / Required customFieldIdToDelete	The ID of the custom field to delete.
Product ID string / Required productCustomFieldsProductId	The ID of the Product to retrieve custom fields for.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete a Modifier

Deletes a Product Modifier. | key: deleteProductModifierAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Modifier ID string / Required modifier_id	The ID of the Modifier.
Product ID text / Required product_id	The ID of the Product to which the modifier will be added.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete a Product

Deletes a Product. | key: deleteProduct

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Product ID to Delete text / Required productIdToDelete	The ID of the Product to delete.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete a Product Variant

Deletes a specific product Variant. | key: deleteProductVariantAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Product ID string / Required product_id	The ID of the Product to which the resource belongs.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Variant ID text / Required variant_id	ID of the variant on a product, or on an associated Price List Record.

---

Delete a Webhook

Deletes a specific webhook from BigCommerce. | key: deleteWebhookAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Webhook ID string / Required webhook_id

---

Delete Brand

Delete a brand by ID. | key: deleteBrand

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand ID to Delete string / Required brandIdToDelete	The ID of the brand to delete.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete Brand Image

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand ID string brandId	Filter brands by ID.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete Categories

Deletes categories based on provided filters. | key: deleteCategories

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
ID string id		Filter items by ID.
ID Greater Than string id_greater		Filter items by ID values greater than the specified value.
ID In string id_in		Filter items by multiple IDs.
ID Less Than string id_less		Filter items by ID values less than the specified value.
ID Max string id_max		Filter items by maximum ID value.
ID Min string id_min		Filter items by minimum ID value.
ID Not In string id_not_in		Exclude items by multiple IDs.
Is Visible boolean isVisible	false	Flag to determine if the category is visible on the storefront.
Keyword string keyword		Filter items by keywords.
Name string name		Filter items by name.
Name Contains string name_like		Filter items by names that contain the specified string.
Page Title string pageTitle
Page Title Like string pageTitle_like		Filter categories by page titles that contain this substring.
Parent ID Greater Than string parent_id_greater		Filter items by Parent ID values greater than the specified value.
Parent ID In string parent_id_in		Filter items by multiple parent IDs.
Parent ID Less Than string parent_id_less		Filter items by Parent ID values less than the specified value.
Parent ID Max string parent_id_max		Filter items by maximum Parent ID value.
Parent ID Min string parent_id_min		Filter items by minimum Parent ID value.
Parent ID string / Required parentId		ID of the parent category. Set to 0 for top-level category.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.

---

Delete Categories

Deletes specified categories in BigCommerce. | key: deleteCategoriesTree

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category ID string / Required category_id	Identifier for the category. Use this to specify a specific category using its ID.
Category UUID string category_uuid	Unique identifier for the category. Use this to specify a specific category using its UUID.
Parent ID string parent_id	Filter items by parent ID.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Tree ID string / Required tree_id	ID of the category tree.

---

Delete Category Trees

Deletes specific Category Trees. | key: deleteCategoryTrees

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
ID In string category_id_in	Filter by specific IDs.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Delete Instanced Webhooks

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

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Destination string destination
Instance URL Pattern string / Required instanceURLPattern
Is Active boolean is_active	false
Items Per Page string limit
Page Number string page
Scope string scope
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.

---

Delete Product Image

Deletes a Product Image. | key: deleteProductImageAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Image ID to Delete string / Required image_id	The ID of the Image that is being operated on.
Product ID string / Required product_id	The ID of the Product to which the image is associated.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get a Category

Returns a single Category. | key: getCategory

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category ID string / Required categoryId	The ID of the category to retrieve.
Exclude Fields string excludeFields	Fields to exclude, in a comma-separated list. The ID cannot be excluded.
Include Fields string includeFields	Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get a Category Tree

Returns a Category Tree. | key: getCategoryTree

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Depth string depth	Max depth for a tree of categories.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Tree ID string / Required tree_id	ID of the category tree.

---

Get a Modifier

Returns a single Product Modifier. | key: getModifierAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Exclude Fields string exclude_fields	Fields to exclude, in a comma-separated list. The ID cannot be excluded.
Include Fields string include_fields	Fields to include, in a comma-separated list.
Modifier ID string / Required modifier_id	The ID of the Modifier.
Product ID string / Required product_id	The ID of the Product to which the modifier belongs.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get a Product Variant

Returns a specific product Variant. | key: getProductVariantAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Exclude Fields text exclude_fields	Fields to exclude, in a comma-separated list.
Include Fields text include_fields	Fields to include, in a comma-separated list.
Product ID text / Required product_id	The ID of the Product to which the modifier will be added.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Variant ID text / Required variant_id	ID of the variant on a product, or on an associated Price List Record.

---

Get All Product Variants

Returns a list of product Variants. | key: getAllProductVariantsAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Exclude Fields text exclude_fields	Fields to exclude, in a comma-separated list.
Include Fields text include_fields	Fields to include, in a comma-separated list.
Limit text limit	Controls the number of items per page in a limited (paginated) list of products.
Page Number text page	Specifies the page number in a limited (paginated) list of products.
Product ID text / Required product_id	The ID of the Product to which the modifier will be added.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get Brand

Retrieve details of a specific brand. | key: getBrand

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand ID string brandId	Filter brands by ID.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get Catalog Summary

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get Product Custom Fields

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Limit string limit	Controls the number of items per page.
Page string page	Specifies the page number in a limited list of products.
Product ID string / Required productCustomFieldsProductId	The ID of the Product to retrieve custom fields for.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get Product Image

Returns a single Product Image. | key: getProductImage

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Image ID string / Required productImageImageId	ID of the image to retrieve.
Product ID for Image string / Required productImageProductId	ID of the product for which to retrieve an image.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Get Webhooks

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

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Destination string destination
Is Active boolean is_active	false
Items Per Page string limit
Page Number string page
Scope string scope
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.

---

List Brands

List all of the store's brands. | key: listBrands

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand Name string brandName	Filter brands by name.
Limit string pageLimit	Controls the number of items per page in a limited (paginated) list of products.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

List Categories

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

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Exclude Fields string exclude_fields		Fields to exclude, in a comma-separated list.
ID string id		Filter items by ID.
ID Greater Than string id_greater		Filter items by ID values greater than the specified value.
ID In string id_in		Filter items by multiple IDs.
ID Less Than string id_less		Filter items by ID values less than the specified value.
ID Max string id_max		Filter items by maximum ID value.
ID Min string id_min		Filter items by minimum ID value.
ID Not In string id_not_in		Exclude items by multiple IDs.
Include Fields string include_fields		Fields to include, in a comma-separated list.
Is Visible boolean is_visible	false	Filter items by if visible on the storefront.
Keyword string keyword		Filter items by keywords.
Limit string limit		Controls the number of items per page.
Name string name		Filter items by name.
Name Contains string name_like		Filter items by names that contain the specified string.
Page string page		Specifies the page number in a limited list of products.
Page Title string page_title		Filter items by page title.
Page Title Contains string page_title_like		Filter items by page titles that contain the specified string.
Parent ID string parent_id		Filter items by parent ID.
Parent ID Greater Than string parent_id_greater		Filter items by Parent ID values greater than the specified value.
Parent ID In string parent_id_in		Filter items by multiple parent IDs.
Parent ID Less Than string parent_id_less		Filter items by Parent ID values less than the specified value.
Parent ID Max string parent_id_max		Filter items by maximum Parent ID value.
Parent ID Min string parent_id_min		Filter items by minimum Parent ID value.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.

---

List Categories (Simplified)

Returns a list of categories. | key: getAllCategoriesSimple

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
ID In string category_id_in	Filter by specific IDs.
Limit string limit	Controls the number of items per page.
Page string page	Specifies the page number in a limited list of products.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

List Category Trees

Returns a list of Category Trees. | key: getAllCategoryTrees

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
ID In string category_id_in	Filter by specific IDs.
Channel ID In string channelId_in	Filter by Channel IDs.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

List Product Images

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Product ID for Images string / Required productImagesProductId	ID of the product for which to retrieve images.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

List Product Modifiers

Returns a list of all Product Modifiers. | key: getAllProductModifiersAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Exclude Fields string exclude_fields	Fields to exclude, in a comma-separated list. The ID cannot be excluded.
Include Fields string include_fields	Fields to include, in a comma-separated list.
Limit string limit	Controls the number of items per page in a limited (paginated) list of products.
Page string page	Specifies the page number in a limited (paginated) list of products.
Product ID string / Required product_id	The ID of the Product to which the modifiers belong.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

List Products

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand ID string productBrandId	Filter items by brand ID.
Product ID string productId	Filter items by product ID.
Limit string productLimit	Controls the number of items per page in a limited (paginated) list of products.
Product Name string productName	Filter items by product name.
Page string productPage	Specifies the page number in a limited (paginated) list of products.
Product Price string productPrice	Filter items by product price.
Product Type string productType	Filter items by product type.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Raw Request

Send raw HTTP request to BigCommerce | key: rawRequest

Input	Default	Notes	Example
BigCommerce Connection connection / Required bigCommerceConnection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	If true, retries on all erroneous responses regardless of type.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required url		This is the URL to call.	/v3/catalog/brands
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries.

---

Update a Modifier

Updates a Product Modifier. | key: updateProductModifierAction

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Configuration code config		The configuration values for the modifier.
Display Name text / Required display_name		The name of the option shown on the storefront.
Modifier ID string / Required modifier_id		The ID of the Modifier.
Option Values code option_values		The option values for the modifier.
Product ID text / Required product_id		The ID of the Product to which the modifier will be added.
Required boolean / Required required	false	Whether or not this modifier is required at checkout.
Sort Order text sort_order		The order the modifiers display on the product detail page.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Modifier Type text / Required type		The type of the modifier. Acceptable values: date, checkbox, etc.

---

Update a Product

Updates a product in the catalog. | key: updateProduct

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Product ID string productId	Filter items by product ID.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Cost Price text uniqueCostPrice	The cost price of the product. Stored for reference only.
Product Depth text uniqueProductDepth	Depth of the product, which can be used when calculating shipping costs.
Product Height text uniqueProductHeight	Height of the product, which can be used when calculating shipping costs.
Product Name text / Required uniqueProductName	A unique product name. Length between 1 to 250 characters.
Product Price text / Required uniqueProductPrice	The price of the product. The price should include or exclude tax, based on the store settings.
Product Type text / Required uniqueProductType	The product type. Either 'physical' or 'digital'.
Product Weight text / Required uniqueProductWeight	Weight of the product. This is based on the unit set on the store.
Product Width text uniqueProductWidth	Width of the product, which can be used when calculating shipping costs.
Retail Price text uniqueRetailPrice	The retail cost of the product. If entered, the retail cost price will be shown on the product page.
Sale Price text uniqueSalePrice	If entered, the sale price will be used instead of value in the price field when calculating the product's cost.

---

Update a Product Variant

Updates a specific product Variant. | key: updateProductVariantAction

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Variant Depth text / Required depth	Depth of the variant.
Variant Height text / Required height	Height of the variant.
Option Values code / Required option_values	Array of option and option values IDs that make up this variant.
Variant Price text / Required price	This variants base price on the storefront.
Product ID string / Required product_id	The ID of the Product to which the resource belongs.
Variant SKU text / Required sku	SKU for the variant. Must be between 1 and 255 characters.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Variant ID text / Required variant_id	ID of the variant on a product, or on an associated Price List Record.
Variant Weight text / Required weight	This variants base weight on the storefront.
Variant Width text / Required width	Width of the variant.

---

Update a Webhook

Updates an existing webhook in BigCommerce. | key: updateWebhookAction

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Destination string destination
Headers code headers
Is Active boolean is_active	false
Scope string scope
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Webhook ID string / Required webhook_id

---

Update Brand

Update a brand's details. | key: updateBrand

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Brand ID to Update string / Required brandIdToUpdate	The ID of the brand to update.
New Brand Name string / Required newBrandName	The updated name for the brand.
New Image URL string newImageUrl	The updated image URL for the brand.
New Page Title string newPageTitle	The updated title shown in the browser while viewing the brand.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Update Categories

Updates existing categories in BigCommerce. | key: updateCategories

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category ID string / Required category_id_update	Unique ID of the category to update.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.
Tree ID string / Required tree_id_update	Unique ID of the tree.

---

Update Category

Updates an existing category in BigCommerce. | key: updateCategory

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category Description text categoryDescription		Description for the category, can include HTML.
Category ID string / Required categoryId		The ID of the category to retrieve.
Category Name string / Required categoryName		Name of the category. It should be unique among its siblings.
Custom URL text customUrl		Custom URL for the category on the storefront.
Default Product Sort string defaultProductSort		Determines how products are sorted on category page load.
Image URL string imageUrl
Is Visible boolean isVisible	false	Flag to determine if the category is visible on the storefront.
Layout File string layoutFile		Layout file for the category. Relevant for Blueprint themes.
Meta Description string metaDescription
Meta Keywords string metaKeywords		Comma-separated list of meta keywords.
Page Title string pageTitle
Parent ID string / Required parentId		ID of the parent category. Set to 0 for top-level category.
Search Keywords string searchKeywords
Sort Order string sortOrder		Priority of this category in the menu and category pages.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Views string views		Number of views the category has on the storefront.

---

Update Custom Field

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

Input	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Custom Field ID to Update string / Required customFieldIdToUpdate	The ID of the custom field to update.
Custom Field Name string / Required customFieldName	The name of the custom field.
Custom Field Value string / Required customFieldValue	The value of the custom field.
Product ID string / Required productCustomFieldsProductId	The ID of the Product to retrieve custom fields for.
Store Hash string / Required storeHash	The unique identifier for the BigCommerce store.

---

Update Product Image

Updates a Product Image. | key: updateProductImageAction

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Image Description string description		The description for the image.
Image File string image_file		The local path to the original image file uploaded to BigCommerce.
Image ID to Update string / Required image_id		The ID of the Image that is being operated on.
Image URL string image_url		Must be a fully qualified URL path, including protocol.
Is Thumbnail boolean is_thumbnail	false	Flag for identifying whether the image is used as the product's thumbnail.
Product ID for Image string / Required product_id		The ID of the Product for which the image is associated.
Sort Order string sort_order		The order in which the image will be displayed on the product page.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Standard Image URL string url_standard		The standard URL for this image.
Thumbnail Image URL string url_thumbnail		The thumbnail URL for this image.
Tiny Image URL string url_tiny		The tiny URL for this image.
Zoom Image URL string url_zoom		The zoom URL for this image.

---

Update Products (Batch)

Updates products in batches. | key: updateProductsBatch

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.
Products (Batch) code / Required uniqueProductBatch		Array of products to update in batches.

---

Upsert Category Trees

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

Input	Default	Notes
BigCommerce Connection connection / Required bigCommerceConnection
Category Tree Data code / Required categoryTreeData		Data to upsert for category trees. Should be a JSON array containing tree objects.
Store Hash string / Required storeHash		The unique identifier for the BigCommerce store.

---