Skip to content

BigCommerce - Get Products

This module allows querying products from a BigCommerce store. It can get a specific product by ID or SKU, or list products with various filters such as category, brand, visibility, price range, and stock.

  • Store Hash: Unique hash of your BigCommerce store (visible in the control panel URL)
  • Access Token: API V3 access token
ParameterTypeRequiredDescription
credentials_idcredentialYesBigCommerce credentials
product_idnumberNoSpecific product ID
skustringNoProduct SKU
namestringNoSearch by name (partial)
categoriesstringNoCategory IDs separated by comma
brand_idnumberNoBrand ID
is_visiblebooleanNoFilter by visibility
availabilityselectNoAvailability: available, disabled, preorder
price_minnumberNoMinimum price
price_maxnumberNoMaximum price
inventory_level_minnumberNoMinimum stock
inventory_level_maxnumberNoMaximum stock
sortselectNoSorting
limitnumberNoResult limit (default: 50)
pagenumberNoResults page (default: 1)
{
"success": true,
"products": [...],
"total": 150,
"total_pages": 3,
"current_page": 1,
"message": "25 products retrieved"
}
  • id: Product ID
  • name: Product name
  • sku: SKU
  • price: Price
  • sale_price: Sale price
  • retail_price: Retail price
  • weight: Weight
  • inventory_level: Available stock
  • is_visible: Visibility
  • categories: Array of category IDs
  • brand_id: Brand ID
  • custom_url: Custom URL
  • images: Array of images
{
"product_id": 123
}
{
"categories": "18,19",
"is_visible": true,
"limit": 100
}
{
"price_min": 10,
"price_max": 100,
"sort": "price:asc"
}
  • Uses the BigCommerce V3 API for products
  • Products are sorted by modification date by default
  • The maximum limit per page is 250 products
  • For SKU searches, the value must be exact