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

OAuth 2.0

key: oauth2bigcommerce

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.
Take note of your application's Client ID and Secret and enter those values when you add a BigCommerce connection to your integration.
Under Redirect URI, add the callback URL, https://oauth2.prismatic.io/callback

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

Triggers

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	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Select Categories

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

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

Select Product Modifiers

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

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

Select Product Variants

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

Select Products

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

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

Actions

Create a Category Image

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

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

{
  "data": {
    "data": {
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/categories/garden.jpg"
    },
    "meta": {}
  }
}

Create a Category Tree

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

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

{
  "data": {
    "data": {
      "id": 25,
      "parent_id": 0,
      "name": "New Category Tree",
      "description": "",
      "views": 0,
      "sort_order": 0,
      "page_title": "",
      "meta_keywords": [],
      "meta_description": "",
      "layout_file": "category.html",
      "image_url": "",
      "is_visible": true,
      "search_keywords": "",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/new-category-tree/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Create a Product Modifier

Creates a Product Modifier. | key: createProductModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Modifier Type	The type of the modifier. Acceptable values: date, checkbox, etc.

{
  "data": {
    "data": {
      "id": 206,
      "product_id": 158,
      "name": "Insurance",
      "display_name": "Insurance",
      "type": "checkbox",
      "required": true,
      "sort_order": 0,
      "config": {
        "checkbox_label": "$5 for insurance",
        "checked_by_default": false
      },
      "option_values": [
        {
          "id": 183,
          "option_id": 206,
          "label": "Yes",
          "sort_order": 0,
          "value_data": {
            "checked_value": true
          },
          "is_default": false,
          "adjusters": {
            "price": {
              "adjuster": "relative",
              "adjuster_value": 5
            },
            "weight": null,
            "image_url": "",
            "purchasing_disabled": {
              "status": false,
              "message": ""
            }
          }
        }
      ]
    },
    "meta": {}
  }
}

Create a Product Variant

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant Weight	This variants base weight on the storefront.
Variant Width	Width of the variant.

{
  "data": {
    "data": {
      "id": 384,
      "product_id": 192,
      "sku": "SMIT-2",
      "sku_id": 350,
      "price": 25,
      "calculated_price": 25,
      "sale_price": 20,
      "retail_price": 25,
      "map_price": null,
      "weight": 2,
      "calculated_weight": 1,
      "width": 5,
      "height": 5,
      "depth": 5,
      "is_free_shipping": false,
      "fixed_cost_shipping_price": 10,
      "purchasing_disabled": false,
      "purchasing_disabled_message": "",
      "image_url": "",
      "cost_price": 25,
      "upc": "",
      "mpn": "",
      "gtin": "",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "",
      "option_values": [
        {
          "id": 176,
          "label": "Black",
          "option_id": 220,
          "option_display_name": "Color"
        }
      ]
    },
    "meta": {}
  }
}

Create a Variant Image

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

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

{
  "data": {
    "data": {
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/variants/variant-image.jpg"
    },
    "meta": {}
  }
}

Create a Webhook

Creates a new webhook in BigCommerce. | key: createWebhookAction

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

{
  "data": {
    "data": {
      "id": 18048287,
      "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
      "store_hash": "sftg45fsd",
      "scope": "store/order/*",
      "destination": "https://665b65a6.ngrok.io/webhooks",
      "headers": {
        "custom-key": "developer-defined value"
      },
      "is_active": true,
      "created_at": 1561488106,
      "updated_at": 1561488106
    },
    "meta": {}
  }
}

Create Brand

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand Name	The unique name for the new Brand to be created.	Nike
Image URL	The fully qualified URL path of the image.	https://cdn.example.com/images/brand-logo.png
Meta Description	The meta description for SEO purposes.	Shop the latest Nike products including shoes, apparel, and accessories.
Meta Keywords	Comma-separated list of meta keywords.
Page Title	The title shown in the browser while viewing the page.	Shop Nike Products
Search Keywords	Comma-separated list of search keywords.	athletic, sportswear, running
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 36,
      "name": "Common Good",
      "page_title": "Common Good",
      "meta_keywords": [
        "modern",
        "clean",
        "contemporary"
      ],
      "meta_description": "Common Good is a modern brand focused on sustainable household products.",
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/brands/common-good.jpg",
      "search_keywords": "common good, sustainable, household",
      "custom_url": {
        "url": "/brands/common-good/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Create Brand Image

Upload an image for a brand. | key: createBrandImage

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

{
  "data": {
    "data": {
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/brands/common-good.jpg"
    },
    "meta": {}
  }
}

Create Category

Creates a new category in BigCommerce. | key: createCategory

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Description	Description for the category, can include HTML.	<p>We offer a wide variety of products perfect for relaxing</p>
Category Name	Name of the category. It should be unique among its siblings.	Bath
Custom URL	Custom URL for the category on the storefront.	/bath-products
Default Product Sort	Determines how products are sorted on category page load.	use_store_settings
Image URL	The fully qualified URL path of the image.	https://cdn.example.com/images/brand-logo.png
Is Visible	When true, the category is visible on the storefront. When false, the category is hidden from customers.	false
Layout File	Layout file for the category. Relevant for Blueprint themes.	category.html
Meta Description	The meta description for SEO purposes.	Shop the latest Nike products including shoes, apparel, and accessories.
Meta Keywords	Comma-separated list of meta keywords.
Page Title	The title shown in the browser while viewing the page.	Shop Nike Products
Parent ID	ID of the parent category. Set to 0 for top-level category.	0
Search Keywords	Comma-separated list of search keywords.	athletic, sportswear, running
Sort Order	Priority of this category in the menu and category pages.	3
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Views	Number of views the category has on the storefront.	1050

{
  "data": {
    "data": {
      "id": 19,
      "parent_id": 0,
      "name": "Garden",
      "description": "<p>This is the garden description</p>",
      "views": 0,
      "sort_order": 2,
      "page_title": "Garden Supplies",
      "meta_keywords": [
        "garden",
        "outdoor",
        "plants"
      ],
      "meta_description": "Browse our selection of garden supplies and tools.",
      "layout_file": "category.html",
      "image_url": "",
      "is_visible": true,
      "search_keywords": "garden, outdoor, plants",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/garden/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Create Custom Field

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

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

{
  "data": {
    "data": {
      "id": 1,
      "name": "Material",
      "value": "Borosilicate Glass"
    },
    "meta": {}
  }
}

Create Modifier Image

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Modifier Image File	The image file 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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Modifier Value ID	The ID of the Modifier Value.

{
  "data": {
    "data": {
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/modifiers/modifier-image.jpg"
    },
    "meta": {}
  }
}

Create Product

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Cost Price	The cost price of the product. Stored for reference only.	15.00
Product Depth	Depth of the product, which can be used when calculating shipping costs.	2
Product Description	The product description, which can include HTML formatting.	<p>100% cotton t-shirt with comfortable fit</p>
Product Height	Height of the product, which can be used when calculating shipping costs.	12
Product Name	A unique product name. Length between 1 to 250 characters.	Premium Cotton T-Shirt
Product Price	The price of the product. The price should include or exclude tax, based on the store settings.	29.99
Product SKU	A unique user-defined alphanumeric product code/stock keeping unit (SKU). Length between 0 to 255 characters.	TSHIRT-BLUE-M
Product Type	The product type. Either 'physical' or 'digital'.	physical
Product Weight	Weight of the product. This is based on the unit set on the store.	0.5
Product Width	Width of the product, which can be used when calculating shipping costs.	10
Retail Price	The retail cost of the product. If entered, the retail cost price will be shown on the product page.	39.99
Sale Price	If entered, the sale price will be used instead of value in the price field when calculating the product's cost.	24.99

{
  "data": {
    "data": {
      "id": 174,
      "name": "1L Le Parfait Jar",
      "type": "physical",
      "sku": "JAR-001",
      "description": "<p>Classic glass jar for preserving and storing.</p>",
      "weight": 1,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 7.95,
      "cost_price": 0,
      "retail_price": 10,
      "sale_price": 0,
      "map_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "",
      "calculated_price": 7.95,
      "categories": [
        23,
        21
      ],
      "brand_id": 36,
      "brand_name": "Common Good",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "reviews_rating_sum": 0,
      "reviews_count": 0,
      "total_sold": 7,
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": false,
      "is_visible": true,
      "is_featured": false,
      "related_products": [
        -1
      ],
      "warranty": "",
      "bin_picking_number": "",
      "layout_file": "product.html",
      "upc": "",
      "mpn": "",
      "gtin": "",
      "search_keywords": "jar, glass",
      "availability": "available",
      "availability_description": "",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [],
      "sort_order": 0,
      "condition": "New",
      "is_condition_shown": false,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "",
      "meta_keywords": [],
      "meta_description": "",
      "date_created": "2018-08-15T14:48:46+00:00",
      "date_modified": "2018-09-05T20:42:07+00:00",
      "view_count": 10,
      "preorder_release_date": null,
      "preorder_message": "",
      "is_preorder_only": false,
      "is_price_hidden": false,
      "price_hidden_label": "",
      "custom_url": {
        "url": "/all/1l-le-parfait-jar/",
        "is_customized": true
      },
      "base_variant_id": 345,
      "open_graph_type": "product",
      "open_graph_title": "",
      "open_graph_description": "",
      "open_graph_use_meta_description": true,
      "open_graph_use_product_name": true,
      "open_graph_use_image": true
    },
    "meta": {}
  }
}

Create Product Image

Creates a Product Image. | key: createProductImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Image File	The local path to the 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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 382,
      "product_id": 174,
      "is_thumbnail": true,
      "sort_order": 0,
      "description": "Main product image",
      "image_file": "products/174/images/jar-main__52168.1534347946.jpg",
      "url_zoom": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/1280x1280/products/174/382/jar-main__52168.1534347946.jpg",
      "url_standard": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/500x659/products/174/382/jar-main__52168.1534347946.jpg",
      "url_thumbnail": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/100x100/products/174/382/jar-main__52168.1534347946.jpg",
      "url_tiny": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/44x44/products/174/382/jar-main__52168.1534347946.jpg",
      "date_modified": "2018-08-15T14:49:15+00:00"
    },
    "meta": {}
  }
}

Delete a Category Image

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

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

{
  "data": null
}

Delete a Custom Field

Deletes a product custom field. | key: deleteCustomField

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

{
  "data": null
}

Delete a Modifier

Deletes a Product Modifier. | key: deleteProductModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": null
}

Delete a Product

Deletes a Product. | key: deleteProduct

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

{
  "data": null
}

Delete a Product Variant

Deletes a specific product Variant. | key: deleteProductVariantAction

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

{
  "data": null
}

Delete a Webhook

Deletes a specific webhook from BigCommerce. | key: deleteWebhookAction

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

{
  "data": {
    "id": 18048287,
    "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
    "store_hash": "sftg45fsd",
    "scope": "store/order/*",
    "destination": "https://665b65a6.ngrok.io/webhooks",
    "headers": {
      "custom-key": "developer-defined value"
    },
    "is_active": true,
    "created_at": 1561488106,
    "updated_at": 1561488106
  }
}

Delete Brand

Delete a brand by ID. | key: deleteBrand

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

{
  "data": null
}

Delete Brand Image

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

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

{
  "data": null
}

Delete Categories

Deletes categories based on provided filters. | key: deleteCategories

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID	Filter items by ID.	39
ID Greater Than	Filter items by ID values greater than the specified value.	50
ID In	Filter items by multiple IDs.
ID Less Than	Filter items by ID values less than the specified value.	75
ID Max	Filter items by maximum ID value.	100
ID Min	Filter items by minimum ID value.	10
ID Not In	Exclude items by multiple IDs.
Is Visible	When true, the category is visible on the storefront. When false, the category is hidden from customers.	false
Keyword	Filter items by keywords.
Name	Filter items by name.
Name Contains	Filter items by names that contain the specified string.
Page Title	The title shown in the browser while viewing the page.	Shop Nike Products
Page Title Like	Filter categories by page titles that contain this substring.	Bath
Parent ID Greater Than	Filter items by Parent ID values greater than the specified value.	20
Parent ID In	Filter items by multiple parent IDs.
Parent ID Less Than	Filter items by Parent ID values less than the specified value.	30
Parent ID Max	Filter items by maximum Parent ID value.	50
Parent ID Min	Filter items by minimum Parent ID value.	5
Parent ID	ID of the parent category. Set to 0 for top-level category.	0
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": null
}

Delete Category Trees

Deletes specific Category Trees. | key: deleteCategoryTrees

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

{
  "data": null
}

Delete Instanced Webhooks

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Destination
Instance URL Pattern
Is Active		false
Items Per Page
Page Number
Scope
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "message": "3 webhooks deleted."
  }
}

Delete Product Image

Deletes a Product Image. | key: deleteProductImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": null
}

Delete Tree Categories

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	Identifier for the category. Use this to specify a specific category using its ID.	45
Category UUID	Unique identifier for the category. Use this to specify a specific category using its UUID.	550e8400-e29b-41d4-a716-446655440000
Parent ID	Filter items by parent ID.	19
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Tree ID	ID of the category tree.	1

{
  "data": null
}

Get a Category

Returns a single Category. | key: getCategory

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category ID	The ID of the category to retrieve.	39
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 19,
      "parent_id": 0,
      "name": "Garden",
      "description": "<p>This is the garden description</p>",
      "views": 0,
      "sort_order": 2,
      "page_title": "Garden Supplies",
      "meta_keywords": [
        "garden",
        "outdoor",
        "plants"
      ],
      "meta_description": "Browse our selection of garden supplies and tools.",
      "layout_file": "category.html",
      "image_url": "",
      "is_visible": true,
      "search_keywords": "garden, outdoor, plants",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/garden/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Get a Category Tree

Returns a Category Tree. | key: getCategoryTree

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Depth	Max depth for a tree of categories.	3
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Tree ID	ID of the category tree.	1

{
  "data": {
    "data": [
      {
        "id": 19,
        "parent_id": 0,
        "depth": 0,
        "path": [
          19
        ],
        "name": "Garden",
        "is_visible": true,
        "children": []
      }
    ],
    "meta": {}
  }
}

Get a Modifier

Returns a single Product Modifier. | key: getModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 206,
      "product_id": 158,
      "name": "Insurance",
      "display_name": "Insurance",
      "type": "checkbox",
      "required": true,
      "sort_order": 0,
      "config": {
        "checkbox_label": "$5 for insurance",
        "checked_by_default": false
      },
      "option_values": [
        {
          "id": 183,
          "option_id": 206,
          "label": "Yes",
          "sort_order": 0,
          "value_data": {
            "checked_value": true
          },
          "is_default": false,
          "adjusters": {
            "price": {
              "adjuster": "relative",
              "adjuster_value": 5
            },
            "weight": null,
            "image_url": "",
            "purchasing_disabled": {
              "status": false,
              "message": ""
            }
          }
        }
      ]
    },
    "meta": {}
  }
}

Get a Product Variant

Returns a specific product Variant. | key: getProductVariantAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Variant ID	ID of the variant on a product, or on an associated Price List Record.

{
  "data": {
    "data": {
      "id": 384,
      "product_id": 192,
      "sku": "SMIT-2",
      "sku_id": 350,
      "price": 25,
      "calculated_price": 25,
      "sale_price": 20,
      "retail_price": 25,
      "map_price": null,
      "weight": 2,
      "calculated_weight": 1,
      "width": 5,
      "height": 5,
      "depth": 5,
      "is_free_shipping": false,
      "fixed_cost_shipping_price": 10,
      "purchasing_disabled": false,
      "purchasing_disabled_message": "",
      "image_url": "",
      "cost_price": 25,
      "upc": "",
      "mpn": "",
      "gtin": "",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "",
      "option_values": [
        {
          "id": 176,
          "label": "Black",
          "option_id": 220,
          "option_display_name": "Color"
        }
      ]
    },
    "meta": {}
  }
}

Get All Product Variants

Returns a list of product Variants. | key: getAllProductVariantsAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 384,
        "product_id": 192,
        "sku": "SMIT-2",
        "sku_id": 350,
        "price": 25,
        "calculated_price": 25,
        "sale_price": 20,
        "retail_price": 25,
        "map_price": null,
        "weight": 2,
        "calculated_weight": 1,
        "width": 5,
        "height": 5,
        "depth": 5,
        "is_free_shipping": false,
        "fixed_cost_shipping_price": 10,
        "purchasing_disabled": false,
        "purchasing_disabled_message": "",
        "image_url": "",
        "cost_price": 25,
        "upc": "",
        "mpn": "",
        "gtin": "",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "bin_picking_number": "",
        "option_values": [
          {
            "id": 176,
            "label": "Black",
            "option_id": 220,
            "option_display_name": "Color"
          }
        ]
      }
    ],
    "meta": {
      "pagination": {
        "total": 3,
        "count": 3,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

Get Brand

Retrieve details of a specific brand. | key: getBrand

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

{
  "data": {
    "data": {
      "id": 36,
      "name": "Common Good",
      "page_title": "Common Good",
      "meta_keywords": [
        "modern",
        "clean",
        "contemporary"
      ],
      "meta_description": "Common Good is a modern brand focused on sustainable household products.",
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/brands/common-good.jpg",
      "search_keywords": "common good, sustainable, household",
      "custom_url": {
        "url": "/brands/common-good/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Get Catalog Summary

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

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

{
  "data": {
    "data": {
      "inventory_count": 458,
      "inventory_value": 12547.5,
      "primary_category_id": 23,
      "primary_category_name": "Shop All",
      "variant_count": 120,
      "highest_variant_price": 299.99,
      "average_variant_price": 42.75,
      "lowest_variant_price": 2.99,
      "oldest_variant_date": "2018-04-05T14:48:46+00:00",
      "newest_variant_date": "2024-12-15T10:22:33+00:00"
    },
    "meta": {}
  }
}

Get Product Custom Fields

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

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

{
  "data": {
    "data": [
      {
        "id": 1,
        "name": "Material",
        "value": "Borosilicate Glass"
      }
    ],
    "meta": {
      "pagination": {
        "total": 2,
        "count": 2,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

Get Product Image

Returns a single Product Image. | key: getProductImage

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 382,
      "product_id": 174,
      "is_thumbnail": true,
      "sort_order": 0,
      "description": "Main product image",
      "image_file": "products/174/images/jar-main__52168.1534347946.jpg",
      "url_zoom": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/1280x1280/products/174/382/jar-main__52168.1534347946.jpg",
      "url_standard": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/500x659/products/174/382/jar-main__52168.1534347946.jpg",
      "url_thumbnail": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/100x100/products/174/382/jar-main__52168.1534347946.jpg",
      "url_tiny": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/44x44/products/174/382/jar-main__52168.1534347946.jpg",
      "date_modified": "2018-08-15T14:49:15+00:00"
    },
    "meta": {}
  }
}

Get Webhooks

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

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

{
  "data": {
    "data": [
      {
        "id": 18048287,
        "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
        "store_hash": "sftg45fsd",
        "scope": "store/order/*",
        "destination": "https://665b65a6.ngrok.io/webhooks",
        "headers": {
          "custom-key": "developer-defined value"
        },
        "is_active": true,
        "created_at": 1561488106,
        "updated_at": 1561488106
      }
    ],
    "meta": {
      "pagination": {
        "count": 5,
        "current_page": 1,
        "per_page": 100,
        "total": 5,
        "total_pages": 1
      }
    }
  }
}

List Brands

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand Name	Filter brands by name.	Apple
Limit	Controls the number of items per page in a limited (paginated) list of products.	50
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 36,
        "name": "Common Good",
        "page_title": "Common Good",
        "meta_keywords": [
          "modern",
          "clean",
          "contemporary"
        ],
        "meta_description": "Common Good is a modern brand focused on sustainable household products.",
        "image_url": "https://cdn11.bigcommerce.com/s-abc123/brands/common-good.jpg",
        "search_keywords": "common good, sustainable, household",
        "custom_url": {
          "url": "/brands/common-good/",
          "is_customized": false
        }
      }
    ],
    "meta": {
      "pagination": {
        "total": 15,
        "count": 15,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

List Categories

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Exclude Fields	Fields to exclude, in a comma-separated list.
ID	Filter items by ID.	39
ID Greater Than	Filter items by ID values greater than the specified value.	50
ID In	Filter items by multiple IDs.
ID Less Than	Filter items by ID values less than the specified value.	75
ID Max	Filter items by maximum ID value.	100
ID Min	Filter items by minimum ID value.	10
ID Not In	Exclude items by multiple IDs.
Include Fields	Fields to include, in a comma-separated list.
Is Visible	When true, filters to show only items visible on the storefront. When false, filters to show only hidden items.	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.	19
Parent ID Greater Than	Filter items by Parent ID values greater than the specified value.	20
Parent ID In	Filter items by multiple parent IDs.
Parent ID Less Than	Filter items by Parent ID values less than the specified value.	30
Parent ID Max	Filter items by maximum Parent ID value.	50
Parent ID Min	Filter items by minimum Parent ID value.	5
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 19,
        "parent_id": 0,
        "name": "Garden",
        "description": "<p>This is the garden description</p>",
        "views": 0,
        "sort_order": 2,
        "page_title": "Garden Supplies",
        "meta_keywords": [
          "garden",
          "outdoor",
          "plants"
        ],
        "meta_description": "Browse our selection of garden supplies and tools.",
        "layout_file": "category.html",
        "image_url": "",
        "is_visible": true,
        "search_keywords": "garden, outdoor, plants",
        "default_product_sort": "use_store_settings",
        "custom_url": {
          "url": "/garden/",
          "is_customized": false
        }
      }
    ],
    "meta": {
      "pagination": {
        "total": 6,
        "count": 6,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

List Categories (Simplified)

Returns a list of categories. | key: getAllCategoriesSimple

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID In	Filter by specific IDs.	39,40,41
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 19,
        "parent_id": 0,
        "name": "Garden",
        "description": "<p>This is the garden description</p>",
        "views": 0,
        "sort_order": 2,
        "page_title": "Garden Supplies",
        "meta_keywords": [
          "garden",
          "outdoor",
          "plants"
        ],
        "meta_description": "Browse our selection of garden supplies and tools.",
        "layout_file": "category.html",
        "image_url": "",
        "is_visible": true,
        "search_keywords": "garden, outdoor, plants",
        "default_product_sort": "use_store_settings",
        "url": {
          "path": "/garden/",
          "is_customized": false
        }
      }
    ],
    "meta": {
      "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

List Category Trees

Returns a list of Category Trees. | key: getAllCategoryTrees

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
ID In	Filter by specific IDs.	39,40,41
Channel ID In	Filter by Channel IDs.	1,2,3
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 1,
        "name": "Default Category Tree",
        "channels": [
          1
        ]
      }
    ],
    "meta": {
      "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

List Product Images

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

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

{
  "data": {
    "data": [
      {
        "id": 382,
        "product_id": 174,
        "is_thumbnail": true,
        "sort_order": 0,
        "description": "Main product image",
        "image_file": "products/174/images/jar-main__52168.1534347946.jpg",
        "url_zoom": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/1280x1280/products/174/382/jar-main__52168.1534347946.jpg",
        "url_standard": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/500x659/products/174/382/jar-main__52168.1534347946.jpg",
        "url_thumbnail": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/100x100/products/174/382/jar-main__52168.1534347946.jpg",
        "url_tiny": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/44x44/products/174/382/jar-main__52168.1534347946.jpg",
        "date_modified": "2018-08-15T14:49:15+00:00"
      }
    ],
    "meta": {
      "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

List Product Modifiers

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 206,
        "product_id": 158,
        "name": "Insurance",
        "display_name": "Insurance",
        "type": "checkbox",
        "required": true,
        "sort_order": 0,
        "config": {
          "checkbox_label": "$5 for insurance",
          "checked_by_default": false
        },
        "option_values": [
          {
            "id": 183,
            "option_id": 206,
            "label": "Yes",
            "sort_order": 0,
            "value_data": {
              "checked_value": true
            },
            "is_default": false,
            "adjusters": {
              "price": {
                "adjuster": "relative",
                "adjuster_value": 5
              },
              "weight": null,
              "image_url": "",
              "purchasing_disabled": {
                "status": false,
                "message": ""
              }
            }
          }
        ]
      }
    ],
    "meta": {
      "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

List Products

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID	Filter items by brand ID.	456
Product ID	Filter items by product ID.	102
Limit	Controls the number of items per page in a limited (paginated) list of products.	50
Product Name	Filter items by product name.	Blue T-Shirt
Page	Specifies the page number in a limited (paginated) list of products.	1
Product Price	Filter items by product price.	29.99
Product Type	Filter items by product type.	physical
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 174,
        "name": "1L Le Parfait Jar",
        "type": "physical",
        "sku": "JAR-001",
        "description": "<p>Classic glass jar for preserving and storing.</p>",
        "weight": 1,
        "width": 0,
        "depth": 0,
        "height": 0,
        "price": 7.95,
        "cost_price": 0,
        "retail_price": 10,
        "sale_price": 0,
        "map_price": 0,
        "tax_class_id": 0,
        "product_tax_code": "",
        "calculated_price": 7.95,
        "categories": [
          23,
          21
        ],
        "brand_id": 36,
        "brand_name": "Common Good",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "inventory_tracking": "none",
        "reviews_rating_sum": 0,
        "reviews_count": 0,
        "total_sold": 7,
        "fixed_cost_shipping_price": 0,
        "is_free_shipping": false,
        "is_visible": true,
        "is_featured": false,
        "related_products": [
          -1
        ],
        "warranty": "",
        "bin_picking_number": "",
        "layout_file": "product.html",
        "upc": "",
        "mpn": "",
        "gtin": "",
        "search_keywords": "jar, glass",
        "availability": "available",
        "availability_description": "",
        "gift_wrapping_options_type": "any",
        "gift_wrapping_options_list": [],
        "sort_order": 0,
        "condition": "New",
        "is_condition_shown": false,
        "order_quantity_minimum": 0,
        "order_quantity_maximum": 0,
        "page_title": "",
        "meta_keywords": [],
        "meta_description": "",
        "date_created": "2018-08-15T14:48:46+00:00",
        "date_modified": "2018-09-05T20:42:07+00:00",
        "view_count": 10,
        "preorder_release_date": null,
        "preorder_message": "",
        "is_preorder_only": false,
        "is_price_hidden": false,
        "price_hidden_label": "",
        "custom_url": {
          "url": "/all/1l-le-parfait-jar/",
          "is_customized": true
        },
        "base_variant_id": 345,
        "open_graph_type": "product",
        "open_graph_title": "",
        "open_graph_description": "",
        "open_graph_use_meta_description": true,
        "open_graph_use_product_name": true,
        "open_graph_use_image": true
      }
    ],
    "meta": {
      "pagination": {
        "total": 36,
        "count": 36,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

Raw Request

Send raw HTTP request to BigCommerce | key: rawRequest

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

{
  "data": {
    "data": [
      {
        "id": 36,
        "name": "Common Good",
        "page_title": "Common Good",
        "meta_keywords": [
          "modern",
          "clean",
          "contemporary"
        ],
        "meta_description": "Common Good is a modern brand focused on sustainable household products.",
        "image_url": "https://cdn11.bigcommerce.com/s-abc123/brands/common-good.jpg",
        "search_keywords": "common good, sustainable, household",
        "custom_url": {
          "url": "/brands/common-good/",
          "is_customized": false
        }
      }
    ],
    "meta": {
      "pagination": {
        "total": 1,
        "count": 1,
        "per_page": 50,
        "current_page": 1,
        "total_pages": 1,
        "links": {
          "current": "?page=1&limit=50"
        }
      }
    }
  }
}

Update a Modifier

Updates a Product Modifier. | key: updateProductModifierAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Modifier Type	The type of the modifier. Acceptable values: date, checkbox, etc.

{
  "data": {
    "data": {
      "id": 206,
      "product_id": 158,
      "name": "Insurance",
      "display_name": "Insurance",
      "type": "checkbox",
      "required": true,
      "sort_order": 0,
      "config": {
        "checkbox_label": "$5 for insurance",
        "checked_by_default": false
      },
      "option_values": [
        {
          "id": 183,
          "option_id": 206,
          "label": "Yes",
          "sort_order": 0,
          "value_data": {
            "checked_value": true
          },
          "is_default": false,
          "adjusters": {
            "price": {
              "adjuster": "relative",
              "adjuster_value": 5
            },
            "weight": null,
            "image_url": "",
            "purchasing_disabled": {
              "status": false,
              "message": ""
            }
          }
        }
      ]
    },
    "meta": {}
  }
}

Update a Product

Updates a product in the catalog. | key: updateProduct

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Product ID	Filter items by product ID.	102
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Cost Price	The cost price of the product. Stored for reference only.	15.00
Product Depth	Depth of the product, which can be used when calculating shipping costs.	2
Product Height	Height of the product, which can be used when calculating shipping costs.	12
Product Name	A unique product name. Length between 1 to 250 characters.	Premium Cotton T-Shirt
Product Price	The price of the product. The price should include or exclude tax, based on the store settings.	29.99
Product Type	The product type. Either 'physical' or 'digital'.	physical
Product Weight	Weight of the product. This is based on the unit set on the store.	0.5
Product Width	Width of the product, which can be used when calculating shipping costs.	10
Retail Price	The retail cost of the product. If entered, the retail cost price will be shown on the product page.	39.99
Sale Price	If entered, the sale price will be used instead of value in the price field when calculating the product's cost.	24.99

{
  "data": {
    "data": {
      "id": 174,
      "name": "1L Le Parfait Jar",
      "type": "physical",
      "sku": "JAR-001",
      "description": "<p>Classic glass jar for preserving and storing.</p>",
      "weight": 1,
      "width": 0,
      "depth": 0,
      "height": 0,
      "price": 7.95,
      "cost_price": 0,
      "retail_price": 10,
      "sale_price": 0,
      "map_price": 0,
      "tax_class_id": 0,
      "product_tax_code": "",
      "calculated_price": 7.95,
      "categories": [
        23,
        21
      ],
      "brand_id": 36,
      "brand_name": "Common Good",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "inventory_tracking": "none",
      "reviews_rating_sum": 0,
      "reviews_count": 0,
      "total_sold": 7,
      "fixed_cost_shipping_price": 0,
      "is_free_shipping": false,
      "is_visible": true,
      "is_featured": false,
      "related_products": [
        -1
      ],
      "warranty": "",
      "bin_picking_number": "",
      "layout_file": "product.html",
      "upc": "",
      "mpn": "",
      "gtin": "",
      "search_keywords": "jar, glass",
      "availability": "available",
      "availability_description": "",
      "gift_wrapping_options_type": "any",
      "gift_wrapping_options_list": [],
      "sort_order": 0,
      "condition": "New",
      "is_condition_shown": false,
      "order_quantity_minimum": 0,
      "order_quantity_maximum": 0,
      "page_title": "",
      "meta_keywords": [],
      "meta_description": "",
      "date_created": "2018-08-15T14:48:46+00:00",
      "date_modified": "2018-09-05T20:42:07+00:00",
      "view_count": 10,
      "preorder_release_date": null,
      "preorder_message": "",
      "is_preorder_only": false,
      "is_price_hidden": false,
      "price_hidden_label": "",
      "custom_url": {
        "url": "/all/1l-le-parfait-jar/",
        "is_customized": true
      },
      "base_variant_id": 345,
      "open_graph_type": "product",
      "open_graph_title": "",
      "open_graph_description": "",
      "open_graph_use_meta_description": true,
      "open_graph_use_product_name": true,
      "open_graph_use_image": true
    },
    "meta": {}
  }
}

Update a Product Variant

Updates a specific product Variant. | key: updateProductVariantAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
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.

{
  "data": {
    "data": {
      "id": 384,
      "product_id": 192,
      "sku": "SMIT-2",
      "sku_id": 350,
      "price": 25,
      "calculated_price": 25,
      "sale_price": 20,
      "retail_price": 25,
      "map_price": null,
      "weight": 2,
      "calculated_weight": 1,
      "width": 5,
      "height": 5,
      "depth": 5,
      "is_free_shipping": false,
      "fixed_cost_shipping_price": 10,
      "purchasing_disabled": false,
      "purchasing_disabled_message": "",
      "image_url": "",
      "cost_price": 25,
      "upc": "",
      "mpn": "",
      "gtin": "",
      "inventory_level": 0,
      "inventory_warning_level": 0,
      "bin_picking_number": "",
      "option_values": [
        {
          "id": 176,
          "label": "Black",
          "option_id": 220,
          "option_display_name": "Color"
        }
      ]
    },
    "meta": {}
  }
}

Update a Webhook

Updates an existing webhook in BigCommerce. | key: updateWebhookAction

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

{
  "data": {
    "data": {
      "id": 18048287,
      "client_id": "m9r6keqmo7h7f23btnpwernbez1kglkl",
      "store_hash": "sftg45fsd",
      "scope": "store/order/*",
      "destination": "https://665b65a6.ngrok.io/webhooks",
      "headers": {
        "custom-key": "developer-defined value"
      },
      "is_active": true,
      "created_at": 1561488106,
      "updated_at": 1561488106
    },
    "meta": {}
  }
}

Update Brand

Update a brand's details. | key: updateBrand

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Brand ID to Update	The ID of the brand to update.	456
New Brand Name	The updated name for the brand.	Nike Sportswear
New Image URL	The updated image URL for the brand.	https://cdn.example.com/images/new-brand-logo.png
New Page Title	The updated title shown in the browser while viewing the brand.	Nike Sportswear Collection
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 36,
      "name": "Common Good",
      "page_title": "Common Good",
      "meta_keywords": [
        "modern",
        "clean",
        "contemporary"
      ],
      "meta_description": "Common Good is a modern brand focused on sustainable household products.",
      "image_url": "https://cdn11.bigcommerce.com/s-abc123/brands/common-good.jpg",
      "search_keywords": "common good, sustainable, household",
      "custom_url": {
        "url": "/brands/common-good/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Update Categories

Updates existing categories in BigCommerce. | key: updateCategories

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

{
  "data": null
}

Update Category

Updates an existing category in BigCommerce. | key: updateCategory

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Description	Description for the category, can include HTML.	<p>We offer a wide variety of products perfect for relaxing</p>
Category ID	The ID of the category to retrieve.	39
Category Name	Name of the category. It should be unique among its siblings.	Bath
Custom URL	Custom URL for the category on the storefront.	/bath-products
Default Product Sort	Determines how products are sorted on category page load.	use_store_settings
Image URL	The fully qualified URL path of the image.	https://cdn.example.com/images/brand-logo.png
Is Visible	When true, the category is visible on the storefront. When false, the category is hidden from customers.	false
Layout File	Layout file for the category. Relevant for Blueprint themes.	category.html
Meta Description	The meta description for SEO purposes.	Shop the latest Nike products including shoes, apparel, and accessories.
Meta Keywords	Comma-separated list of meta keywords.
Page Title	The title shown in the browser while viewing the page.	Shop Nike Products
Parent ID	ID of the parent category. Set to 0 for top-level category.	0
Search Keywords	Comma-separated list of search keywords.	athletic, sportswear, running
Sort Order	Priority of this category in the menu and category pages.	3
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
Views	Number of views the category has on the storefront.	1050

{
  "data": {
    "data": {
      "id": 19,
      "parent_id": 0,
      "name": "Garden",
      "description": "<p>This is the garden description</p>",
      "views": 0,
      "sort_order": 2,
      "page_title": "Garden Supplies",
      "meta_keywords": [
        "garden",
        "outdoor",
        "plants"
      ],
      "meta_description": "Browse our selection of garden supplies and tools.",
      "layout_file": "category.html",
      "image_url": "",
      "is_visible": true,
      "search_keywords": "garden, outdoor, plants",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/garden/",
        "is_customized": false
      }
    },
    "meta": {}
  }
}

Update Custom Field

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Custom Field ID to Update	The ID of the custom field to update.	7
Custom Field Name	The name of the custom field.	warranty_months
Custom Field Value	The value of the custom field.	12
Product ID	The ID of the Product to retrieve custom fields for.	105
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": {
      "id": 1,
      "name": "Material",
      "value": "Borosilicate Glass"
    },
    "meta": {}
  }
}

Update Product Image

Updates a Product Image. | key: updateProductImageAction

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
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. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3
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.

{
  "data": {
    "data": {
      "id": 382,
      "product_id": 174,
      "is_thumbnail": true,
      "sort_order": 0,
      "description": "Main product image",
      "image_file": "products/174/images/jar-main__52168.1534347946.jpg",
      "url_zoom": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/1280x1280/products/174/382/jar-main__52168.1534347946.jpg",
      "url_standard": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/500x659/products/174/382/jar-main__52168.1534347946.jpg",
      "url_thumbnail": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/100x100/products/174/382/jar-main__52168.1534347946.jpg",
      "url_tiny": "https://cdn11.bigcommerce.com/s-abc123/images/stencil/44x44/products/174/382/jar-main__52168.1534347946.jpg",
      "date_modified": "2018-08-15T14:49:15+00:00"
    },
    "meta": {}
  }
}

Update Products (Batch)

Updates products in batches. | key: updateProductsBatch

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

{
  "data": {
    "data": [
      {
        "id": 174,
        "name": "1L Le Parfait Jar",
        "type": "physical",
        "sku": "JAR-001",
        "description": "<p>Classic glass jar for preserving and storing.</p>",
        "weight": 1,
        "width": 0,
        "depth": 0,
        "height": 0,
        "price": 7.95,
        "cost_price": 0,
        "retail_price": 10,
        "sale_price": 0,
        "map_price": 0,
        "tax_class_id": 0,
        "product_tax_code": "",
        "calculated_price": 7.95,
        "categories": [
          23,
          21
        ],
        "brand_id": 36,
        "brand_name": "Common Good",
        "inventory_level": 0,
        "inventory_warning_level": 0,
        "inventory_tracking": "none",
        "reviews_rating_sum": 0,
        "reviews_count": 0,
        "total_sold": 7,
        "fixed_cost_shipping_price": 0,
        "is_free_shipping": false,
        "is_visible": true,
        "is_featured": false,
        "related_products": [
          -1
        ],
        "warranty": "",
        "bin_picking_number": "",
        "layout_file": "product.html",
        "upc": "",
        "mpn": "",
        "gtin": "",
        "search_keywords": "jar, glass",
        "availability": "available",
        "availability_description": "",
        "gift_wrapping_options_type": "any",
        "gift_wrapping_options_list": [],
        "sort_order": 0,
        "condition": "New",
        "is_condition_shown": false,
        "order_quantity_minimum": 0,
        "order_quantity_maximum": 0,
        "page_title": "",
        "meta_keywords": [],
        "meta_description": "",
        "date_created": "2018-08-15T14:48:46+00:00",
        "date_modified": "2018-09-05T20:42:07+00:00",
        "view_count": 10,
        "preorder_release_date": null,
        "preorder_message": "",
        "is_preorder_only": false,
        "is_price_hidden": false,
        "price_hidden_label": "",
        "custom_url": {
          "url": "/all/1l-le-parfait-jar/",
          "is_customized": true
        },
        "base_variant_id": 345,
        "open_graph_type": "product",
        "open_graph_title": "",
        "open_graph_description": "",
        "open_graph_use_meta_description": true,
        "open_graph_use_product_name": true,
        "open_graph_use_image": true
      }
    ],
    "meta": {}
  }
}

Upsert Category Trees

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

Input	Notes	Example
BigCommerce Connection	The BigCommerce connection to use.
Category Tree Data	Data to upsert for category trees. Should be a JSON array containing tree objects.
Store Hash	The unique identifier for the BigCommerce store. Find this in your store's API credentials or URL (e.g., the store hash from https://api.bigcommerce.com/stores/{store_hash}).	abc12defg3

{
  "data": {
    "data": [
      {
        "id": 1,
        "name": "Default Category Tree",
        "channels": [
          1
        ]
      }
    ],
    "meta": {}
  }
}

Changelog

2026-04-10

Updated example payloads

2026-04-07

Added global debug support across all actions for improved troubleshooting

2026-03-31

Various modernizations and documentation updates

2025-07-29

Renamed delete tree categories action for improved clarity and consistency

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

Description​

Connections​

OAuth 2.0​

Triggers​

Webhook​

Data Sources​

Select Brands​

Select Categories​

Select Product Modifiers​

Select Product Variants​

Select Products​

Actions​

Create a Category Image​

Create a Category Tree​

Create a Product Modifier​

Create a Product Variant​

Create a Variant Image​

Create a Webhook​

Create Brand​

Create Brand Image​

Create Category​

Create Custom Field​

Create Modifier Image​

Create Product​

Create Product Image​

Delete a Category Image​

Delete a Custom Field​

Delete a Modifier​

Delete a Product​

Delete a Product Variant​

Delete a Webhook​

Delete Brand​

Delete Brand Image​

Delete Categories​

Delete Category Trees​

Delete Instanced Webhooks​

Delete Product Image​

Delete Tree Categories​

Get a Category​

Get a Category Tree​

Get a Modifier​

Get a Product Variant​

Get All Product Variants​

Get Brand​

Get Catalog Summary​

Get Product Custom Fields​

Get Product Image​

Get Webhooks​

List Brands​

List Categories​

List Categories (Simplified)​

List Category Trees​

List Product Images​

List Product Modifiers​

List Products​

Raw Request​

Update a Modifier​

Update a Product​

Update a Product Variant​

Update a Webhook​

Update Brand​

Update Categories​

Update Category​

Update Custom Field​

Update Product Image​

Update Products (Batch)​

Upsert Category Trees​

Changelog​

2026-04-10​

2026-04-07​

2026-03-31​

2025-07-29​