Skip to main content

BigCommerce Connector

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

Connections

BigCommerce OAuth 2.0

BigCommerce OAuth 2.0

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
ScopesA space-delimited set of one or more scopes to get the user's permission to access.store_v2_default
Client ID
Client Secret

Triggers

Webhook

Receive and validate webhook requests from BigCommerce for webhooks you configure.

Actions

Create a Category Image

Upload an image for a specific category.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Category IDThe ID of the category to retrieve.
Image FileThe image file to be uploaded.

Create a Category Tree

Creates a new category tree in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Parent IDSet to 0 for top level category. Otherwise, set to the ID of the parent category.
Category NameThe name displayed for the category.

Create a Product Modifier

Creates a Product Modifier.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier will be added.
Modifier TypeThe type of the modifier. Acceptable values: date, checkbox, etc.
RequiredWhether or not this modifier is required at checkout.false
Sort OrderThe order the modifiers display on the product detail page.
ConfigurationThe configuration values for the modifier.
Option ValuesThe option values for the modifier.
Display NameThe name of the option shown on the storefront.

Create a Product Variant

Creates a new product variant in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the resource belongs.
Variant SKUSKU for the variant. Must be between 1 and 255 characters.
Option ValuesArray of option and option values IDs that make up this variant.
Variant PriceThis variants base price on the storefront.
Variant WeightThis variants base weight on the storefront.
Variant WidthWidth of the variant.
Variant HeightHeight of the variant.
Variant DepthDepth of the variant.

Create a Variant Image

Creates or updates an image for a specific product variant.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the resource belongs.
Variant IDID of the variant on a product, or on an associated Price List Record.
Image URL

Create a Webhook

Creates a new webhook in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Scope
Destination
Is Activefalse
Events History Enabled (Deprecated)false
Headers

Create Brand

Create a new brand in the store.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand NameThe unique name for the new Brand to be created.
Page Title
Meta KeywordsComma-separated list of meta keywords.
Meta Description
Search Keywords
Image URL

Create Brand Image

Upload an image for a brand.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand IDFilter brands by ID.
Image FileThe image file to be uploaded.

Create Category

Creates a new category in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Parent IDID of the parent category. Set to 0 for top-level category.
Category NameName of the category. It should be unique among its siblings.
Category DescriptionDescription for the category, can include HTML.
ViewsNumber of views the category has on the storefront.
Sort OrderPriority of this category in the menu and category pages.
Page Title
Search Keywords
Meta KeywordsComma-separated list of meta keywords.
Meta Description
Layout FileLayout file for the category. Relevant for Blueprint themes.
Is VisibleFlag to determine if the category is visible on the storefront.false
Default Product SortDetermines how products are sorted on category page load.
Image URL
Custom URLCustom URL for the category on the storefront.

Create Custom Field

Creates a custom field for a product.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to retrieve custom fields for.
Custom Field NameThe name of the custom field.
Custom Field ValueThe value of the custom field.

Create Modifier Image

Creates an image for a product modifier value.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier will be added.
Modifier IDThe ID of the Modifier.
Modifier Value IDThe ID of the Modifier Value.
Modifier Image FileThe image file to upload for the modifier.

Create Product

Creates a new product in the store.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product NameA unique product name. Length between 1 to 250 characters.
Product TypeThe product type. Either 'physical' or 'digital'.
Product PriceThe price of the product. The price should include or exclude tax, based on the store settings.
Product SKUA unique user-defined alphanumeric product code/stock keeping unit (SKU). Length between 0 to 255 characters.
Product DescriptionThe product description, which can include HTML formatting.
Product WeightWeight of the product. This is based on the unit set on the store.
Product WidthWidth of the product, which can be used when calculating shipping costs.
Product DepthDepth of the product, which can be used when calculating shipping costs.
Product HeightHeight of the product, which can be used when calculating shipping costs.
Cost PriceThe cost price of the product. Stored for reference only.
Retail PriceThe retail cost of the product. If entered, the retail cost price will be shown on the product page.
Sale PriceIf 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.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe unique numeric identifier for the product with which the image is associated.
Image FileThe local path to the original image file uploaded to BigCommerce. A multipart/form-data media type.
Image URLThe fully qualified URL path of the image. Limit of 8MB per file.

Delete a Category Image

Deletes an image associated with a given category.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Category IDThe ID of the category to retrieve.

Delete a Custom Field

Deletes a product custom field.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to retrieve custom fields for.
Custom Field ID to DeleteThe ID of the custom field to delete.

Delete a Modifier

Deletes a Product Modifier.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier will be added.
Modifier IDThe ID of the Modifier.

Delete a Product

Deletes a Product.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product ID to DeleteThe ID of the Product to delete.

Delete a Product Variant

Deletes a specific product Variant.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the resource belongs.
Variant IDID of the variant on a product, or on an associated Price List Record.

Delete a Webhook

Deletes a specific webhook from BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Webhook ID

Delete Brand

Delete a brand by ID.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand ID to DeleteThe ID of the brand to delete.

Delete Brand Image

Delete an image for a brand by ID.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand IDFilter brands by ID.

Delete Categories

Deletes categories based on provided filters.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
IDFilter items by ID.
ID InFilter items by multiple IDs.
ID Not InExclude items by multiple IDs.
ID MinFilter items by minimum ID value.
ID MaxFilter items by maximum ID value.
ID Greater ThanFilter items by ID values greater than the specified value.
ID Less ThanFilter items by ID values less than the specified value.
NameFilter items by name.
Parent IDID of the parent category. Set to 0 for top-level category.
Page Title
KeywordFilter items by keywords.
Is VisibleFlag to determine if the category is visible on the storefront.false
Name ContainsFilter items by names that contain the specified string.
Parent ID InFilter items by multiple parent IDs.
Parent ID MinFilter items by minimum Parent ID value.
Parent ID MaxFilter items by maximum Parent ID value.
Parent ID Greater ThanFilter items by Parent ID values greater than the specified value.
Parent ID Less ThanFilter items by Parent ID values less than the specified value.
Page Title LikeFilter categories by page titles that contain this substring.

Delete Categories

Deletes specified categories in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Category UUIDUnique identifier for the category. Use this to specify a specific category using its UUID.
Category IDIdentifier for the category. Use this to specify a specific category using its ID.
Tree IDID of the category tree.
Parent IDFilter items by parent ID.

Delete Category Trees

Deletes specific Category Trees.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
ID InFilter by specific IDs.

Delete Instanced Webhooks

Deletes all webhooks that point to a flow in this instance.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Instance URL Pattern
Page Number
Items Per Page
Is Activefalse
Scope
Destination

Delete Product Image

Deletes a Product Image.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the image is associated.
Image ID to DeleteThe ID of the Image that is being operated on.

Get a Category

Returns a single Category.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Category IDThe ID of the category to retrieve.
Include FieldsFields to include, in a comma-separated list. The ID and the specified fields will be returned.
Exclude FieldsFields to exclude, in a comma-separated list. The ID cannot be excluded.

Get a Category Tree

Returns a Category Tree.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Tree IDID of the category tree.
DepthMax depth for a tree of categories.

Get All Product Variants

Returns a list of product Variants.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier will be added.
Page NumberSpecifies the page number in a limited (paginated) list of products.
LimitControls the number of items per page in a limited (paginated) list of products.
Include FieldsFields to include, in a comma-separated list.
Exclude FieldsFields to exclude, in a comma-separated list.

Get a Modifier

Returns a single Product Modifier.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier belongs.
Modifier IDThe ID of the Modifier.
Include FieldsFields to include, in a comma-separated list.
Exclude FieldsFields to exclude, in a comma-separated list. The ID cannot be excluded.

Get a Product Variant

Returns a specific product Variant.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier will be added.
Variant IDID of the variant on a product, or on an associated Price List Record.
Include FieldsFields to include, in a comma-separated list.
Exclude FieldsFields to exclude, in a comma-separated list.

Get Brand

Retrieve details of a specific brand.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand IDFilter brands by ID.

Get Catalog Summary

Returns a lightweight inventory summary from the BigCommerce Catalog.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.

Get Product Custom Fields

Returns a list of product custom fields.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to retrieve custom fields for.
PageSpecifies the page number in a limited list of products.
LimitControls the number of items per page.

Get Product Image

Returns a single Product Image.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product ID for ImageID of the product for which to retrieve an image.
Image IDID of the image to retrieve.

Get Webhooks

Returns a list of all webhooks on a store.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Page Number
Items Per Page
Is Activefalse
Scope
Destination

List Brands

List all of the store's brands.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand NameFilter brands by name.
LimitControls the number of items per page in a limited (paginated) list of products.

List Categories

Retrieve a list of categories with optional filters.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
IDFilter items by ID.
ID InFilter items by multiple IDs.
ID Not InExclude items by multiple IDs.
ID MinFilter items by minimum ID value.
ID MaxFilter items by maximum ID value.
ID Greater ThanFilter items by ID values greater than the specified value.
ID Less ThanFilter items by ID values less than the specified value.
NameFilter items by name.
Name ContainsFilter items by names that contain the specified string.
Parent IDFilter items by parent ID.
Parent ID InFilter items by multiple parent IDs.
Parent ID MinFilter items by minimum Parent ID value.
Parent ID MaxFilter items by maximum Parent ID value.
Parent ID Greater ThanFilter items by Parent ID values greater than the specified value.
Parent ID Less ThanFilter items by Parent ID values less than the specified value.
Page TitleFilter items by page title.
Page Title ContainsFilter items by page titles that contain the specified string.
KeywordFilter items by keywords.
Is VisibleFilter items by if visible on the storefront.false
PageSpecifies the page number in a limited list of products.
LimitControls the number of items per page.
Include FieldsFields to include, in a comma-separated list.
Exclude FieldsFields to exclude, in a comma-separated list.

List Categories (Simplified)

Returns a list of categories.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
ID InFilter by specific IDs.
LimitControls the number of items per page.
PageSpecifies the page number in a limited list of products.

List Category Trees

Returns a list of Category Trees.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
ID InFilter by specific IDs.
Channel ID InFilter by Channel IDs.

List Product Images

Returns a list of product images with optional filter parameters.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product ID for ImagesID of the product for which to retrieve images.

List Product Modifiers

Returns a list of all Product Modifiers.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifiers belong.
PageSpecifies the page number in a limited (paginated) list of products.
LimitControls the number of items per page in a limited (paginated) list of products.
Include FieldsFields to include, in a comma-separated list.
Exclude FieldsFields to exclude, in a comma-separated list. The ID cannot be excluded.

List Products

Returns a list of products with optional filter parameters.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDFilter items by product ID.
Product NameFilter items by product name.
Product PriceFilter items by product price.
Brand IDFilter items by brand ID.
Product TypeFilter items by product type.
PageSpecifies the page number in a limited (paginated) list of products.
LimitControls the number of items per page in a limited (paginated) list of products.

Raw Request

Send raw HTTP request to BigCommerce

InputCommentsDefault
URLThis is the URL to call.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA 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.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf 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
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.

Update a Modifier

Updates a Product Modifier.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the modifier will be added.
Modifier IDThe ID of the Modifier.
Modifier TypeThe type of the modifier. Acceptable values: date, checkbox, etc.
RequiredWhether or not this modifier is required at checkout.false
Sort OrderThe order the modifiers display on the product detail page.
ConfigurationThe configuration values for the modifier.
Option ValuesThe option values for the modifier.
Display NameThe name of the option shown on the storefront.

Update a Product

Updates a product in the catalog.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDFilter items by product ID.
Product NameA unique product name. Length between 1 to 250 characters.
Product TypeThe product type. Either 'physical' or 'digital'.
Product WeightWeight of the product. This is based on the unit set on the store.
Product WidthWidth of the product, which can be used when calculating shipping costs.
Product DepthDepth of the product, which can be used when calculating shipping costs.
Product HeightHeight of the product, which can be used when calculating shipping costs.
Product PriceThe price of the product. The price should include or exclude tax, based on the store settings.
Cost PriceThe cost price of the product. Stored for reference only.
Retail PriceThe retail cost of the product. If entered, the retail cost price will be shown on the product page.
Sale PriceIf 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.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to which the resource belongs.
Variant IDID of the variant on a product, or on an associated Price List Record.
Variant SKUSKU for the variant. Must be between 1 and 255 characters.
Option ValuesArray of option and option values IDs that make up this variant.
Variant PriceThis variants base price on the storefront.
Variant WeightThis variants base weight on the storefront.
Variant WidthWidth of the variant.
Variant HeightHeight of the variant.
Variant DepthDepth of the variant.

Update a Webhook

Updates an existing webhook in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Webhook ID
Scope
Destination
Is Activefalse
Headers

Update Brand

Update a brand's details.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Brand ID to UpdateThe ID of the brand to update.
New Brand NameThe updated name for the brand.
New Page TitleThe updated title shown in the browser while viewing the brand.
New Image URLThe updated image URL for the brand.

Update Categories

Updates existing categories in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Tree IDUnique ID of the tree.
Category IDUnique ID of the category to update.

Update Category

Updates an existing category in BigCommerce.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Category IDThe ID of the category to retrieve.
Parent IDID of the parent category. Set to 0 for top-level category.
Category NameName of the category. It should be unique among its siblings.
Category DescriptionDescription for the category, can include HTML.
ViewsNumber of views the category has on the storefront.
Sort OrderPriority of this category in the menu and category pages.
Page Title
Search Keywords
Meta KeywordsComma-separated list of meta keywords.
Meta Description
Layout FileLayout file for the category. Relevant for Blueprint themes.
Is VisibleFlag to determine if the category is visible on the storefront.false
Default Product SortDetermines how products are sorted on category page load.
Image URL
Custom URLCustom URL for the category on the storefront.

Update Custom Field

Updates a custom field for a product.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product IDThe ID of the Product to retrieve custom fields for.
Custom Field ID to UpdateThe ID of the custom field to update.
Custom Field NameThe name of the custom field.
Custom Field ValueThe value of the custom field.

Update Product Image

Updates a Product Image.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Product ID for ImageThe ID of the Product for which the image is associated.
Image ID to UpdateThe ID of the Image that is being operated on.
Image FileThe local path to the original image file uploaded to BigCommerce.
Image URLMust be a fully qualified URL path, including protocol.
Zoom Image URLThe zoom URL for this image.
Standard Image URLThe standard URL for this image.
Thumbnail Image URLThe thumbnail URL for this image.
Tiny Image URLThe tiny URL for this image.
Is ThumbnailFlag for identifying whether the image is used as the product's thumbnail.false
Sort OrderThe order in which the image will be displayed on the product page.
Image DescriptionThe description for the image.

Update Products (Batch)

Updates products in batches.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Products (Batch)Array of products to update in batches.
[
{
"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
}
]

Upsert Category Trees

Upserts Category Trees. This single endpoint updates and creates category trees.

InputCommentsDefault
BigCommerce Connection
Store HashThe unique identifier for the BigCommerce store.
Category Tree DataData to upsert for category trees. Should be a JSON array containing tree objects.
{
"id": 0,
"name": "string",
"channel_ids": [
0
]
}