CData Python Connector for BigCommerce

Build 26.0.9770

Products

Returns product records, including pricing, inventory, and media details.

Table Specific Information

Select

The connector uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

  • Id supports the =, >=, >, <=, and < comparisons.
  • Name supports the = comparison.
  • Sku supports the = comparison.
  • Description supports the = comparison.
  • Price supports the = comparison.
  • IsVisible supports the = comparison.
  • IsFeatured supports the = comparison.
  • InventoryLevel supports the =, >=, >, <=, and < comparisons.
  • BrandId supports the = comparison.
  • DateModified supports the =, >=, >, <=, and < comparisons.
  • Condition supports the = comparison.
  • DateLastImported supports the =, >=, >, <=, and < comparisons.
  • Availability supports the = comparison.
  • Categories supports the = and IN comparisons.

The rest of the filter is executed client-side within the connector. For example, the following queries are processed server-side: 

SELECT * FROM Products WHERE Id > 5 AND Id < 10

SELECT * FROM Products WHERE IsVisible = "true"

Insert

To insert a product, specify at least the following columns: Name, Type, Description, Price, Categories, Availability and Weight. 

INSERT INTO Products (Name, Type, Description, Price, Categories, Availability, Weight) VALUES ("Plain T-Shirt", "physical", "This is a test description", 29.99, 18, "available", 0.5)

Inserting products with multiple variants using a temp table: 

INSERT INTO ProductVariantValues#TEMP (Label, DisplayName, Id) VALUES ('Blue', 'Color', 1)
INSERT INTO ProductVariantValues#TEMP (Label, DisplayName, Id) VALUES ('Yellow', 'Color', 2)

INSERT INTO ProductVariants#TEMP (Sku, LinkedOptionValues, Id) VALUES ('SKU-AB', 'ProductVariantValues#TEMP', 1)
INSERT INTO ProductVariants#TEMP (Sku, LinkedOptionValues, Id) VALUES ('SKU-CD', 'ProductVariantValues#TEMP', 2)

INSERT INTO Products (Name, Type, Weight, Price, ProductVariants) VALUES ('BC-8', 'physical', 60, 5700, 'ProductVariants#TEMP')

Inserting products with multiple variants using aggregates: 

INSERT INTO Products (Name, Type, Weight, Price, ProductVariants) VALUES ('BC-95', 'physical', 99, 5800, '[{"Sku": "SKU-MM","option_values": [{"option_display_name": "Song","Id": "1","label": "Mary"}]}, {"Sku": "SKU-DE","option_values": [{"option_display_name": "Song","Id": "2","label": "Jane"}]}]')

Inserting products with one variant: 

INSERT INTO ProductVariantValues#TEMP (Label, DisplayName) VALUES ('Blue', 'Color')

INSERT INTO ProductVariants#TEMP (Sku, LinkedOptionValues) VALUES ('SKU-AB', 'ProductVariantValues#TEMP')

INSERT INTO Products (Name, Type, Weight, Price, ProductVariants) VALUES ('BC-8', 'physical', 60, 5700, 'ProductVariants#TEMP')

Bulk Update

To perform a bulk update on products, specify at least the following columns: Description, Id, Name, Sku, and RelatedProducts. 

INSERT INTO Update#TEMP (Description, Id, Name, Sku, Categories, RelatedProducts, MetaKeywords, IsCustomized, Url) VALUES ('my_details', '80', 'hello123', 'OTL', '19, 23', '1, 2', '"pqr", "xyz"', false, '/orbit-terrarium-large/'
INSERT INTO Update#TEMP (Description, Id, Name, Sku, Categories, RelatedProducts, MetaKeywords, IsCustomized, Url) VALUES ('my_details1', '86', 'example', 'ABS', '23, 21', '3, 4', '"abc", "an"', false, '/able-brewing-system/'
UPDATE products (Description, Id, Name, Sku, Categories, RelatedProducts, MetaKeywords, IsCustomized, Url) SELECT Description, Id, Name, Sku, Categories, RelatedProducts, MetaKeywords, IsCustomized, Url FROM Update#TEMP

Bulk update using aggregates: 

INSERT INTO Update#TEMP (Description, Id, Name, Sku, categories, RelatedProducts, MetaKeywords, CustomUrl) VALUES ('details1', '77', 'name4456', 'SLCTBS', '23, 18', '10', '"abcd", "ab"',
            '{
			  "is_customized": False,
			  "url" : "/fog-linen-chambray-towel-beige-stripe/"
             }')
UPDATE products (Description, Id, Name, Sku, Categories, RelatedProducts, CustomUrl) SELECT Description, Id, Name, Sku, Categories, RelatedProducts, CustomUrl FROM Update#TEMP

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

The Id of the product.

Name String False

The product name.

Type String False

The product type.

Sku String True

The user-defined product code or stock keeping unit (SKU).

Description String False

The product description, which can include HTML formatting.

SearchKeywords String False

A comma-separated list of keywords that can be used to locate the product when searching the store.

AvailabilityDescription String False

The availability text displayed on the checkout page under the product title, indicating how long it will normally take to ship this product.

Price Decimal False

The product's price.

CostPrice Decimal False

The product's cost price.

RetailPrice Decimal False

The product's retail price.

SalePrice Decimal False

The sale price of the product.

MapPrice Decimal False

The minimum advertised price (MAP) for the product.

ProductTaxCode String False

The tax code assigned to the product for tax calculation purposes.

CalculatedPrice Decimal True

The price as displayed to guests, adjusted for applicable sale prices and rules.

SortOrder Integer False

The priority assigned to this product when included in product lists on category pages and in search results.

IsVisible Boolean False

Indicates whether the product is displayed to customers browsing the store.

IsFeatured Boolean False

Indicates whether the product is included in the featured products panel for shoppers viewing the store.

RelatedProducts String False

Defaults to -1, which causes the store to automatically generate a list of related products.

InventoryLevel Integer False

The current inventory level of the product.

InventoryWarningLevel Integer False

The inventory warning level for the product.

Warranty String False

The warranty information displayed on the product page.

Weight Decimal False

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

Width Decimal False

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

Height Decimal False

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

Depth Decimal False

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

FixedCostShippingPrice Decimal False

A fixed shipping cost for the product.

IsFreeShipping Boolean False

Indicates whether the product qualifies for free shipping.

InventoryTracking String False

The type of inventory tracking for the product.

RatingTotal Integer False

The total rating for the product.

RatingCount Integer False

The total number of ratings the product has had.

ReviewsRatingSum Integer True

The total (cumulative) rating for the product.

ReviewsCount Integer True

The number of times the product has been rated.

TotalSold Integer False

The total quantity of this product sold through transactions.

DateCreated Datetime False

The date on which the product was created.

BrandId Integer True

The Id of the brand associated with the product.

ViewCount Integer False

The number of times the product has been viewed.

PageTitle String False

The custom title for the product's page.

MetaKeywords String False

The custom meta keywords for the product page.

MetaDescription String False

The custom meta description for the product page.

LayoutFile String False

The layout template file used to render this product category.

IsPriceHidden Boolean False

Indicates whether the product price is hidden on the product page. Defaults to false, meaning the price is displayed.

PriceHiddenLabel String False

By default, an empty string. If is_price_hidden is true, the value of price_hidden_label will be displayed instead of the price.

Categories String False

An array of Ids for the categories this product belongs to. When updating a product, if an array of categories is supplied, then all product categories will be overwritten.

DateModified Datetime False

The date that the product was last modified.

Condition String False

The product's condition.

The allowed values are new, used, refurbished.

IsConditionShown Boolean False

Indicates whether the product's condition is displayed to the customer on the product page.

PreorderReleaseDate Datetime False

The pre-order release date for the product.

IsPreorderOnly Boolean False

Indicates whether the product remains available for pre-order only and does not automatically transition to available status on the release date.

PreorderMessage String False

The custom expected-date message displayed on the product page.

OrderQuantityMinimum Integer False

The minimum quantity an order must contain in order to purchase this product.

OrderQuantityMaximum Integer False

The maximum quantity an order can contain when purchasing the product.

OpenGraphType String False

The Open Graph type for the product page.

The allowed values are product, album, book, drink, food, game, movie, song, tv_show.

OpenGraphTitle String False

The Open Graph title for the product page. If not specified, the product's name is used instead.

OpenGraphDescription String False

The Open Graph description for the product page.

OpenGraphUseMetaDescription Boolean False

Indicates whether the product description is used instead of the Open Graph description.

OpenGraphUseProductName Boolean False

Indicates whether the product name is used instead of the Open Graph title.

OpenGraphUseImage Boolean False

Indicates whether the product image is used instead of the Open Graph image.

IsOpenGraphThumbnail Boolean False

Indicates whether the product thumbnail image is used as the Open Graph image.

UPC String False

The product UPC code, which is used in feeds for shopping comparison sites.

GTIN String False

The Global Trade Item Number (GTIN) for the product.

OptionSetId Integer True

The Id of the option set applied to the product.

TaxClassId Integer True

The Id of the tax class applied to the product.

OptionSetDisplay String True

The position on the product page where options from the option set will be displayed.

BinPickingNumber String False

The BIN picking number for the product.

CustomUrl String False

The custom URL overriding the default URL structure dictated by the store's settings, if set.

CustomFields String False

The custom fields for the product. A maximum of 200 custom fields per product and 255 characters per custom field are supported.

ManufacturerPartNumber String False

The manufacturer part number (MPN) for the product.

IsCustomized Boolean False

Indicates whether the URL has been changed from its default auto-assigned state.

Url String False

The product URL on the storefront.

Availability String False

The availability status of the product.

PrimaryImageId Integer True

The Id of the primary product image.

PrimaryImageProductId Integer True

The Id of the product associated with the primary image.

PrimaryImageIsThumbnail Boolean True

Indicates whether the primary image is used as a thumbnail.

PrimaryImageSortOrder String True

The sort order of the primary image.

PrimaryImageDescription String True

The description of the primary image.

PrimaryImageImageFile String True

The image file of the primary image.

PrimaryImageUrlZoom String True

The zoom URL of the primary image.

PrimaryImageStandardUrl String True

The standard URL of the primary image.

PrimaryImageUrlThumbnail String True

The thumbnail URL of the primary image.

PrimaryImageUrlTiny String True

The tiny URL of the primary image.

PrimaryImageDateModified Datetime True

The date the primary image was last modified.

GiftWrappingOptionsType String True

The type of gift-wrapping options available for the product.

GiftWrappingOptionsList String True

The list of gift-wrapping option Ids available for the product.

BaseVariantId String True

The Id of the base variant for the product.

VideoURL String True

Returns the URL of the first video hosted on the site. To retrieve all video URLs, refer to the ProductVideos view.

Channels String True

The channels to which the product is assigned.

DateLastImported Datetime False

The date the product was last imported.

Pseudocolumns

Pseudo column fields are used to enable the user to INSERT Fields that are non-readable but required during creation of new records.

Name Type Description
ProductVariants String

The variants of the product.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770