BigCommerce - Product Mapping

The table below lists all the possible mappings supported via the BigCommerce Connector. For a more detailed description for each field see the REST API BigCommerce documentation.

Mapping to field	Output Kind	Description

Mapping to field	Output Kind	Description
Name (Required)	Field	A unique product name. The Name can be used as key by setting BigCommerceProductKeyType to ‘Name’, but this is only recommended for initialized run for updating SyncID.
Sku (*Required)	Field	A unique user-defined alphanumeric stock keeping unit. By default, the Sku is used as key and as such is required. If the Sku is not used as key the field is optional.
SyncID	Field	To use Product Id as key, map a string Feature to SyncID. When the SyncID is mapped, the connector will use product Id as a key and the BigCommerce Connector will update the SyncID after the product is synchronized. To force the Sku or Name as key, set the setting parameter ‘BigCommerceProductKeyType’ to ‘Sku’ or ‘Name’ and empty SyncID’s will be updated with Product Id’s.
SyncDate	Field	SyncDate is used together with SuncID to use Product Id as key. This parameter will be updated from BigCommerce Connector after the product is synchronized. If the SyncDate is used in Product Mapping, the SyncDate need to be set at the Variant as well.
SyncMsg	Field	SyncMsg will be used for reporting errors back to products in Perfion.
Type	Field	The product type. A physical stock unit or a digital download. Allowed values: physical (Default) digital
Description	Field	The product description, which can include HTML formatting.
Weight	Field	Weight of the product, which can be used when calculating shipping costs. Default value is 0
Width	Field	Width of the product.
Depth	Field	Depth of the product.
Height	Field	Height of the product
Price	Field	The price of the product. Default value is 0.
Cost_Price	Field	The cost price of the product.
Retail_Price	Field	The retail cost of the product.
Sale_Price	Field	If entered, the sale price will be used instead of value in the price field when calculating the product's cost.
Map_Price	Field	Minimum Advertised Price
Tax_Class_Id	Field	The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)
Product_Tax_Code	Field	Tax Codes, such as AvaTax System Tax Codes, identify products and services that fall into special sales-tax categories.
Brand_Name	Field	The brand name of the product. If the brand already exists, the product will be adds to the brand. If not, the brand will be created and then adds the product to the brand.
Inventory_Level	Field	Current inventory level of the product.
Inventory_Warning_Level	Field	Inventory warning level for the product.
Inventory_Tracking	Field	The type of inventory tracking for the product. Allowed values: none product variant
Fixed_Cost_Shipping_Price	Field	A fixed shipping cost for the product.
Is_Free_Shipping	Field	A boolean true/false to set free shipping.
Is_Visible	Field	A boolean true/false to set the Product is visible or not.
Is_Featured	Field	A boolean true/false to determine whether the product should be included in the featured products panel when viewing the store.
Related_Products	Field	A multi feature containing BigCommerce Product Id’s
Warranty	Field	Warranty information displayed on the product page. Can include HTML formatting.
Bin_Picking_Number	Field	The BIN picking number for the product.
Layout_File	Field	A html layout file. Please refer to the BigCommerce documentation for more information.
Upc	Field	The product UPC code.
Search_Keywords	Field	A comma-separated list or a multi feature of keywords that can be used to locate the product when searching the store.
Availability_Description	Field	Availability text displayed on the checkout page.
Availability	Field	Availability of the product. Allowed values: available – the product is available for purchase disabled – the product is listed on the storefront, but cannot be purchased preorder – the product is listed for pre-orders
Gift_Wrapping_Options_Type	Field	Type of gift-wrapping options. Allowed values: any – allow any gift-wrapping options in the store none – disallow gift-wrapping on the product list – provide a list of IDs in the gift_wrapping_options_list field
Gift_Wrapping_Options_List	Field	A multi feature of gift-wrapping option IDs.
Sort_Order	Field	Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results.
Condition	Field	The product condition
Is_Condition_Shown	Field	A boolean true/false to determine whether the product condition is shown to the customer on the product page.
Order_Quantity_Minimum	Field	The minimum quantity an order must contain, to be eligible to purchase this product
Order_Quantity_Maximum	Field	The maximum quantity an order can contain when purchasing the product
Page_Title	Field	Custom title for the product page
Meta_Keywords	Field	Custom meta keywords for the product page
Meta_Description	Field	Custom meta description for the product page
View_Count	Field	The number of times the product has been viewed
Preorder_Release_Date	Field	Pre-order release date
Preorder_Message	Field	Custom expected-date message to display on the product page
Is_Preorder_Only	Field	If set to true then on the preorder release date the preorder status will automatically be removed. If set to false, then on the release date the preorder status will not be removed
Is_Price_Hidden	Field	Indicating that this product's price should be shown on the product page. If set to true, the price is hidden
Price_Hidden_Label	Field	If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price
Custom_Url	Field	The custom URL for the product on the storefront.
Open_Graph_Type	Field	Type of product. Allowed values: product album book drink food game movie song tv_show
Open_Graph_Title	Field	Title of the product
Open_Graph_Description	Field	Description to use for the product
Open_Graph_Use_Meta_Description	Field	A boolean true/false to determine if product description or open graph description is used
Open_Graph_Use_Product_Name	Field	A boolean true/false to determine if product name or open graph name is used
Open_Graph_Use_Image	Field	A boolean true/false to determine if product image or open graph image is used
Gtin	Field	Global Trade Item Number
Mpn	Field	Manufacturer Part Number
Reviews_Rating_Sum	Field	The total (cumulative) rating for the product
Reviews_Count	Field	The number of times the product has been rated.
Total_Sold	Field	The total quantity of this product sold
Channels	Field	Comma separated values or a multi feature of values of Channels/Storefronts the products should be attached to. This mapping will overwrite the setting BigCommerceDefaultProductChannels. Default value is the default channel (channel_id=1). If it is set to blank, the products will not be attached to a storefront.
image_url	Field	Must be a fully qualified URL path, including protocol. Limit of 8MB. The image_url will be the thumbnail image if both image_url and image_urls are used
image_url	Image(Url)	An image stored in Perfion (Required the Perfion API is publicly available). Limit of 8MB. The image_url will be the thumbnail image if both image_url and image_urls are used
image_urls	Field	Must be a fully qualified URL path, including protocol, from a multi feature. Limit of 8MB per url. If image_url is not used, the thumbnail image will be the first image in image_urls.
image_urls	Image(Url)	Images stored in Perfion (Required the Perfion API is publicly available), from a multi feature. Limit of 8MB per url. If image_url is not used, the thumbnail image will be the first image in image_urls.
Videos_Youtube	Field	The Youtube Id of the video.
<Custom_Fields>	Field	Custom fields allow you to specify additional information that will appear on the products page. 200 maximum custom fields per product. 255 maximum characters per custom field.
<Custom_Fields>@BigCommerceCaptionTemplate and <Custom_Fields>@BigCommerceValueTemplate	Attribute	Template for Custom Field. Custom Field has a Caption and a Value. Both Captions and Values can be formatted e.g. %CAPTION% %UNIT%. Default value is %NAME% for Caption and %VALUE% for Value Tags available: CAPTION – Caption from the feature definition in the language set in Languages setting CAPTIONALTERNATIVE – Caption alternative from the feature definition in the language set in Languages setting UNIT – Unit from the feature definition in the language set in Languages setting ABBREVIATION – Abbreviation from the feature definition in the language set in Languages setting HELPTEXT – Help text from the feature definition in the language set in Languages setting NAME – Name from the mapping VALUE – Value formatted to the culture defined in Languages setting (Decimal separator and date format)
<Any_Fields>@ignore	Attribute	Set the <Any_Fields>@ignore = 'True' (Include the single quotation) to ignore a mapping as a field to be used in BigCommerce. E.g. If the KeyField need to be set for variants mapping, but the KeyField should not be visible in the shop.