Skip to main content

BigCommerce Component

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

Component key: bigcommerce

Changelog ↓

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 when you add a BigCommerce connection to your integration.
  3. Under Redirect URI, add the callback URL, https://oauth2.prismatic.io/callback
InputNotesExample
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
Client Secret
Scopes

A space-delimited set of one or more scopes to get the user's permission to access.

store_v2_default
Token URL

The OAuth 2.0 Token URL for BigCommerce

https://login.bigcommerce.com/oauth2/token

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

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.


Select Categories

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

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.


Select Product Modifiers

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

InputNotesExample
BigCommerce Connection
Product ID

The ID of the Product to which the modifiers belong.

Store Hash

The unique identifier for the BigCommerce store.


Select Product Variants

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

InputNotesExample
BigCommerce Connection
Exclude Fields

Fields to exclude, in a comma-separated list.

Include Fields

Fields to include, in a comma-separated list.

Limit

Controls the number of items per page in a limited (paginated) list of products.

Page Number

Specifies the page number in a limited (paginated) list of products.

Product ID

The ID of the Product to which the modifier will be added.

Store Hash

The unique identifier for the BigCommerce store.


Select Products

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

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.


Actions

Create a Category Image

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

InputNotesExample
BigCommerce Connection
Category ID

The ID of the category to retrieve.

Image File

The image file to be uploaded.

Store Hash

The unique identifier for the BigCommerce store.


Create a Category Tree

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

InputNotesExample
BigCommerce Connection
Category Name

The name displayed for the category.

Parent ID

Set to 0 for top level category. Otherwise, set to the ID of the parent category.

Store Hash

The unique identifier for the BigCommerce store.


Create a Product Modifier

Creates a Product Modifier. | key: createProductModifierAction

InputNotesExample
BigCommerce Connection
Configuration

The configuration values for the modifier.

Display Name

The name of the option shown on the storefront.

Option Values

The option values for the modifier.

Product ID

The ID of the Product to which the modifier will be added.

Required

Whether or not this modifier is required at checkout.

false
Sort Order

The order the modifiers display on the product detail page.

Store Hash

The unique identifier for the BigCommerce store.

Modifier Type

The type of the modifier. Acceptable values: date, checkbox, etc.


Create a Product Variant

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

InputNotesExample
BigCommerce Connection
Variant Depth

Depth of the variant.

Variant Height

Height of the variant.

Option Values

Array of option and option values IDs that make up this variant.

Variant Price

This variants base price on the storefront.

Product ID

The ID of the Product to which the resource belongs.

Variant SKU

SKU for the variant. Must be between 1 and 255 characters.

Store Hash

The unique identifier for the BigCommerce store.

Variant Weight

This variants base weight on the storefront.

Variant Width

Width of the variant.


Create a Variant Image

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

InputNotesExample
BigCommerce Connection
Image URL
Product ID

The ID of the Product to which the resource belongs.

Store Hash

The unique identifier for the BigCommerce store.

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

InputNotesExample
BigCommerce Connection
Destination
Events History Enabled (Deprecated)false
Headers
Is Activefalse
Scope
Store Hash

The unique identifier for the BigCommerce store.


Create Brand

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

InputNotesExample
BigCommerce Connection
Brand Name

The unique name for the new Brand to be created.

Image URL
Meta Description
Meta Keywords

Comma-separated list of meta keywords.

Page Title
Search Keywords
Store Hash

The unique identifier for the BigCommerce store.


Create Brand Image

Upload an image for a brand. | key: createBrandImage

InputNotesExample
BigCommerce Connection
Brand ID

Filter brands by ID.

Image File

The image file to be uploaded.

Store Hash

The unique identifier for the BigCommerce store.


Create Category

Creates a new category in BigCommerce. | key: createCategory

InputNotesExample
BigCommerce Connection
Category Description

Description for the category, can include HTML.

Category Name

Name of the category. It should be unique among its siblings.

Custom URL

Custom URL for the category on the storefront.

Default Product Sort

Determines how products are sorted on category page load.

Image URL
Is Visible

Flag to determine if the category is visible on the storefront.

false
Layout File

Layout file for the category. Relevant for Blueprint themes.

Meta Description
Meta Keywords

Comma-separated list of meta keywords.

Page Title
Parent ID

ID of the parent category. Set to 0 for top-level category.

Search Keywords
Sort Order

Priority of this category in the menu and category pages.

Store Hash

The unique identifier for the BigCommerce store.

Views

Number of views the category has on the storefront.


Create Custom Field

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

InputNotesExample
BigCommerce Connection
Custom Field Name

The name of the custom field.

Custom Field Value

The value of the custom field.

Product ID

The ID of the Product to retrieve custom fields for.

Store Hash

The unique identifier for the BigCommerce store.


Create Modifier Image

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

InputNotesExample
BigCommerce Connection
Modifier Image File

The image file to upload for the modifier.

Modifier ID

The ID of the Modifier.

Product ID

The ID of the Product to which the modifier will be added.

Store Hash

The unique identifier for the BigCommerce store.

Modifier Value ID

The ID of the Modifier Value.


Create Product

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

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.

Cost Price

The cost price of the product. Stored for reference only.

Product Depth

Depth of the product, which can be used when calculating shipping costs.

Product Description

The product description, which can include HTML formatting.

Product Height

Height of the product, which can be used when calculating shipping costs.

Product Name

A unique product name. Length between 1 to 250 characters.

Product Price

The price of the product. The price should include or exclude tax, based on the store settings.

Product SKU

A unique user-defined alphanumeric product code/stock keeping unit (SKU). Length between 0 to 255 characters.

Product Type

The product type. Either 'physical' or 'digital'.

Product Weight

Weight of the product. This is based on the unit set on the store.

Product Width

Width of the product, which can be used when calculating shipping costs.

Retail Price

The retail cost of the product. If entered, the retail cost price will be shown on the product page.

Sale Price

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

InputNotesExample
BigCommerce Connection
Image File

The local path to the original image file uploaded to BigCommerce. A multipart/form-data media type.

Image URL

The fully qualified URL path of the image. Limit of 8MB per file.

Product ID

The unique numeric identifier for the product with which the image is associated.

Store Hash

The unique identifier for the BigCommerce store.


Delete a Category Image

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

InputNotesExample
BigCommerce Connection
Category ID

The ID of the category to retrieve.

Store Hash

The unique identifier for the BigCommerce store.


Delete a Custom Field

Deletes a product custom field. | key: deleteCustomField

InputNotesExample
BigCommerce Connection
Custom Field ID to Delete

The ID of the custom field to delete.

Product ID

The ID of the Product to retrieve custom fields for.

Store Hash

The unique identifier for the BigCommerce store.


Delete a Modifier

Deletes a Product Modifier. | key: deleteProductModifierAction

InputNotesExample
BigCommerce Connection
Modifier ID

The ID of the Modifier.

Product ID

The ID of the Product to which the modifier will be added.

Store Hash

The unique identifier for the BigCommerce store.


Delete a Product

Deletes a Product. | key: deleteProduct

InputNotesExample
BigCommerce Connection
Product ID to Delete

The ID of the Product to delete.

Store Hash

The unique identifier for the BigCommerce store.


Delete a Product Variant

Deletes a specific product Variant. | key: deleteProductVariantAction

InputNotesExample
BigCommerce Connection
Product ID

The ID of the Product to which the resource belongs.

Store Hash

The unique identifier for the BigCommerce store.

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

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.

Webhook ID

Delete Brand

Delete a brand by ID. | key: deleteBrand

InputNotesExample
BigCommerce Connection
Brand ID to Delete

The ID of the brand to delete.

Store Hash

The unique identifier for the BigCommerce store.


Delete Brand Image

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

InputNotesExample
BigCommerce Connection
Brand ID

Filter brands by ID.

Store Hash

The unique identifier for the BigCommerce store.


Delete Categories

Deletes categories based on provided filters. | key: deleteCategories

InputNotesExample
BigCommerce Connection
ID

Filter items by ID.

ID Greater Than

Filter items by ID values greater than the specified value.

ID In

Filter items by multiple IDs.

ID Less Than

Filter items by ID values less than the specified value.

ID Max

Filter items by maximum ID value.

ID Min

Filter items by minimum ID value.

ID Not In

Exclude items by multiple IDs.

Is Visible

Flag to determine if the category is visible on the storefront.

false
Keyword

Filter items by keywords.

Name

Filter items by name.

Name Contains

Filter items by names that contain the specified string.

Page Title
Page Title Like

Filter categories by page titles that contain this substring.

Parent ID Greater Than

Filter items by Parent ID values greater than the specified value.

Parent ID In

Filter items by multiple parent IDs.

Parent ID Less Than

Filter items by Parent ID values less than the specified value.

Parent ID Max

Filter items by maximum Parent ID value.

Parent ID Min

Filter items by minimum Parent ID value.

Parent ID

ID of the parent category. Set to 0 for top-level category.

Store Hash

The unique identifier for the BigCommerce store.


Delete Category Trees

Deletes specific Category Trees. | key: deleteCategoryTrees

InputNotesExample
BigCommerce Connection
ID In

Filter by specific IDs.

Store Hash

The unique identifier for the BigCommerce store.


Delete Instanced Webhooks

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

InputNotesExample
BigCommerce Connection
Destination
Instance URL Pattern
Is Activefalse
Items Per Page
Page Number
Scope
Store Hash

The unique identifier for the BigCommerce store.


Delete Product Image

Deletes a Product Image. | key: deleteProductImageAction

InputNotesExample
BigCommerce Connection
Image ID to Delete

The ID of the Image that is being operated on.

Product ID

The ID of the Product to which the image is associated.

Store Hash

The unique identifier for the BigCommerce store.


Delete Tree Categories

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

InputNotesExample
BigCommerce Connection
Category ID

Identifier for the category. Use this to specify a specific category using its ID.

Category UUID

Unique identifier for the category. Use this to specify a specific category using its UUID.

Parent ID

Filter items by parent ID.

Store Hash

The unique identifier for the BigCommerce store.

Tree ID

ID of the category tree.


Get a Category

Returns a single Category. | key: getCategory

InputNotesExample
BigCommerce Connection
Category ID

The ID of the category to retrieve.

Exclude Fields

Fields to exclude, in a comma-separated list. The ID cannot be excluded.

Include Fields

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

Store Hash

The unique identifier for the BigCommerce store.


Get a Category Tree

Returns a Category Tree. | key: getCategoryTree

InputNotesExample
BigCommerce Connection
Depth

Max depth for a tree of categories.

Store Hash

The unique identifier for the BigCommerce store.

Tree ID

ID of the category tree.


Get a Modifier

Returns a single Product Modifier. | key: getModifierAction

InputNotesExample
BigCommerce Connection
Exclude Fields

Fields to exclude, in a comma-separated list. The ID cannot be excluded.

Include Fields

Fields to include, in a comma-separated list.

Modifier ID

The ID of the Modifier.

Product ID

The ID of the Product to which the modifier belongs.

Store Hash

The unique identifier for the BigCommerce store.


Get a Product Variant

Returns a specific product Variant. | key: getProductVariantAction

InputNotesExample
BigCommerce Connection
Exclude Fields

Fields to exclude, in a comma-separated list.

Include Fields

Fields to include, in a comma-separated list.

Product ID

The ID of the Product to which the modifier will be added.

Store Hash

The unique identifier for the BigCommerce store.

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

InputNotesExample
BigCommerce Connection
Exclude Fields

Fields to exclude, in a comma-separated list.

Include Fields

Fields to include, in a comma-separated list.

Limit

Controls the number of items per page in a limited (paginated) list of products.

Page Number

Specifies the page number in a limited (paginated) list of products.

Product ID

The ID of the Product to which the modifier will be added.

Store Hash

The unique identifier for the BigCommerce store.


Get Brand

Retrieve details of a specific brand. | key: getBrand

InputNotesExample
BigCommerce Connection
Brand ID

Filter brands by ID.

Store Hash

The unique identifier for the BigCommerce store.


Get Catalog Summary

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

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.


Get Product Custom Fields

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

InputNotesExample
BigCommerce Connection
Limit

Controls the number of items per page.

Page

Specifies the page number in a limited list of products.

Product ID

The ID of the Product to retrieve custom fields for.

Store Hash

The unique identifier for the BigCommerce store.


Get Product Image

Returns a single Product Image. | key: getProductImage

InputNotesExample
BigCommerce Connection
Image ID

ID of the image to retrieve.

Product ID for Image

ID of the product for which to retrieve an image.

Store Hash

The unique identifier for the BigCommerce store.


Get Webhooks

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

InputNotesExample
BigCommerce Connection
Destination
Is Activefalse
Items Per Page
Page Number
Scope
Store Hash

The unique identifier for the BigCommerce store.


List Brands

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

InputNotesExample
BigCommerce Connection
Brand Name

Filter brands by name.

Limit

Controls the number of items per page in a limited (paginated) list of products.

Store Hash

The unique identifier for the BigCommerce store.


List Categories

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

InputNotesExample
BigCommerce Connection
Exclude Fields

Fields to exclude, in a comma-separated list.

ID

Filter items by ID.

ID Greater Than

Filter items by ID values greater than the specified value.

ID In

Filter items by multiple IDs.

ID Less Than

Filter items by ID values less than the specified value.

ID Max

Filter items by maximum ID value.

ID Min

Filter items by minimum ID value.

ID Not In

Exclude items by multiple IDs.

Include Fields

Fields to include, in a comma-separated list.

Is Visible

Filter items by if visible on the storefront.

false
Keyword

Filter items by keywords.

Limit

Controls the number of items per page.

Name

Filter items by name.

Name Contains

Filter items by names that contain the specified string.

Page

Specifies the page number in a limited list of products.

Page Title

Filter items by page title.

Page Title Contains

Filter items by page titles that contain the specified string.

Parent ID

Filter items by parent ID.

Parent ID Greater Than

Filter items by Parent ID values greater than the specified value.

Parent ID In

Filter items by multiple parent IDs.

Parent ID Less Than

Filter items by Parent ID values less than the specified value.

Parent ID Max

Filter items by maximum Parent ID value.

Parent ID Min

Filter items by minimum Parent ID value.

Store Hash

The unique identifier for the BigCommerce store.


List Categories (Simplified)

Returns a list of categories. | key: getAllCategoriesSimple

InputNotesExample
BigCommerce Connection
ID In

Filter by specific IDs.

Limit

Controls the number of items per page.

Page

Specifies the page number in a limited list of products.

Store Hash

The unique identifier for the BigCommerce store.


List Category Trees

Returns a list of Category Trees. | key: getAllCategoryTrees

InputNotesExample
BigCommerce Connection
ID In

Filter by specific IDs.

Channel ID In

Filter by Channel IDs.

Store Hash

The unique identifier for the BigCommerce store.


List Product Images

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

InputNotesExample
BigCommerce Connection
Product ID for Images

ID of the product for which to retrieve images.

Store Hash

The unique identifier for the BigCommerce store.


List Product Modifiers

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

InputNotesExample
BigCommerce Connection
Exclude Fields

Fields to exclude, in a comma-separated list. The ID cannot be excluded.

Include Fields

Fields to include, in a comma-separated list.

Limit

Controls the number of items per page in a limited (paginated) list of products.

Page

Specifies the page number in a limited (paginated) list of products.

Product ID

The ID of the Product to which the modifiers belong.

Store Hash

The unique identifier for the BigCommerce store.


List Products

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

InputNotesExample
BigCommerce Connection
Brand ID

Filter items by brand ID.

Product ID

Filter items by product ID.

Limit

Controls the number of items per page in a limited (paginated) list of products.

Product Name

Filter items by product name.

Page

Specifies the page number in a limited (paginated) list of products.

Product Price

Filter items by product price.

Product Type

Filter items by product type.

Store Hash

The unique identifier for the BigCommerce store.


Raw Request

Send raw HTTP request to BigCommerce | key: rawRequest

InputNotesExample
BigCommerce Connection
Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
Debug Request

Enabling this flag will log out the current request.

false
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.

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

Update a Modifier

Updates a Product Modifier. | key: updateProductModifierAction

InputNotesExample
BigCommerce Connection
Configuration

The configuration values for the modifier.

Display Name

The name of the option shown on the storefront.

Modifier ID

The ID of the Modifier.

Option Values

The option values for the modifier.

Product ID

The ID of the Product to which the modifier will be added.

Required

Whether or not this modifier is required at checkout.

false
Sort Order

The order the modifiers display on the product detail page.

Store Hash

The unique identifier for the BigCommerce store.

Modifier Type

The type of the modifier. Acceptable values: date, checkbox, etc.


Update a Product

Updates a product in the catalog. | key: updateProduct

InputNotesExample
BigCommerce Connection
Product ID

Filter items by product ID.

Store Hash

The unique identifier for the BigCommerce store.

Cost Price

The cost price of the product. Stored for reference only.

Product Depth

Depth of the product, which can be used when calculating shipping costs.

Product Height

Height of the product, which can be used when calculating shipping costs.

Product Name

A unique product name. Length between 1 to 250 characters.

Product Price

The price of the product. The price should include or exclude tax, based on the store settings.

Product Type

The product type. Either 'physical' or 'digital'.

Product Weight

Weight of the product. This is based on the unit set on the store.

Product Width

Width of the product, which can be used when calculating shipping costs.

Retail Price

The retail cost of the product. If entered, the retail cost price will be shown on the product page.

Sale Price

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

InputNotesExample
BigCommerce Connection
Variant Depth

Depth of the variant.

Variant Height

Height of the variant.

Option Values

Array of option and option values IDs that make up this variant.

Variant Price

This variants base price on the storefront.

Product ID

The ID of the Product to which the resource belongs.

Variant SKU

SKU for the variant. Must be between 1 and 255 characters.

Store Hash

The unique identifier for the BigCommerce store.

Variant ID

ID of the variant on a product, or on an associated Price List Record.

Variant Weight

This variants base weight on the storefront.

Variant Width

Width of the variant.


Update a Webhook

Updates an existing webhook in BigCommerce. | key: updateWebhookAction

InputNotesExample
BigCommerce Connection
Destination
Headers
Is Activefalse
Scope
Store Hash

The unique identifier for the BigCommerce store.

Webhook ID

Update Brand

Update a brand's details. | key: updateBrand

InputNotesExample
BigCommerce Connection
Brand ID to Update

The ID of the brand to update.

New Brand Name

The updated name for the brand.

New Image URL

The updated image URL for the brand.

New Page Title

The updated title shown in the browser while viewing the brand.

Store Hash

The unique identifier for the BigCommerce store.


Update Categories

Updates existing categories in BigCommerce. | key: updateCategories

InputNotesExample
BigCommerce Connection
Category ID

Unique ID of the category to update.

Store Hash

The unique identifier for the BigCommerce store.

Tree ID

Unique ID of the tree.


Update Category

Updates an existing category in BigCommerce. | key: updateCategory

InputNotesExample
BigCommerce Connection
Category Description

Description for the category, can include HTML.

Category ID

The ID of the category to retrieve.

Category Name

Name of the category. It should be unique among its siblings.

Custom URL

Custom URL for the category on the storefront.

Default Product Sort

Determines how products are sorted on category page load.

Image URL
Is Visible

Flag to determine if the category is visible on the storefront.

false
Layout File

Layout file for the category. Relevant for Blueprint themes.

Meta Description
Meta Keywords

Comma-separated list of meta keywords.

Page Title
Parent ID

ID of the parent category. Set to 0 for top-level category.

Search Keywords
Sort Order

Priority of this category in the menu and category pages.

Store Hash

The unique identifier for the BigCommerce store.

Views

Number of views the category has on the storefront.


Update Custom Field

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

InputNotesExample
BigCommerce Connection
Custom Field ID to Update

The ID of the custom field to update.

Custom Field Name

The name of the custom field.

Custom Field Value

The value of the custom field.

Product ID

The ID of the Product to retrieve custom fields for.

Store Hash

The unique identifier for the BigCommerce store.


Update Product Image

Updates a Product Image. | key: updateProductImageAction

InputNotesExample
BigCommerce Connection
Image Description

The description for the image.

Image File

The local path to the original image file uploaded to BigCommerce.

Image ID to Update

The ID of the Image that is being operated on.

Image URL

Must be a fully qualified URL path, including protocol.

Is Thumbnail

Flag for identifying whether the image is used as the product's thumbnail.

false
Product ID for Image

The ID of the Product for which the image is associated.

Sort Order

The order in which the image will be displayed on the product page.

Store Hash

The unique identifier for the BigCommerce store.

Standard Image URL

The standard URL for this image.

Thumbnail Image URL

The thumbnail URL for this image.

Tiny Image URL

The tiny URL for this image.

Zoom Image URL

The zoom URL for this image.


Update Products (Batch)

Updates products in batches. | key: updateProductsBatch

InputNotesExample
BigCommerce Connection
Store Hash

The unique identifier for the BigCommerce store.

Products (Batch)

Array of products to update in batches.


Upsert Category Trees

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

InputNotesExample
BigCommerce Connection
Category Tree Data

Data to upsert for category trees. Should be a JSON array containing tree objects.

Store Hash

The unique identifier for the BigCommerce store.


Changelog

2025-07-29

Renamed delete tree categories action for improved clarity and consistency.