BigCommerce | app | app | This component uses the BigCommerce app. |
Name | name | string | The product name. >= 1 characters <= 250 characters
|
Type | type | string | Select a value from the drop down menu:physical digital |
SKU | sku | string | User defined product code/stock keeping unit (SKU). >= 0 characters <= 255 characters Example: SM-13
|
Description | description | string | The product description, which can include HTML formatting.
|
Weight | weight | any | Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store >= 0 and <= 9999999999
|
Width | width | any | Width of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
|
Depth | depth | any | Depth of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
|
Height | height | any | Height of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
|
Price | price | any | The price of the product. The price should include or exclude tax, based on the store settings. >= 0
|
Cost Price | cost_price | any | The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store. >=0
|
Retail Price | retail_price | any | The retail cost of the product. If entered, the retail cost price will be shown on the product page. >=0
|
Sale Price | sale_price | any | If entered, the sale price will be used instead of value in the price field when calculating the product's cost. >=0
|
Map Price | map_price | integer | |
Tax class id | tax_class_id | integer | Select a value from the drop down menu. |
Product tax code | product_tax_code | string | Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation. >= 0 characters <= 255 characters
|
Categories | categories | integer[] | Select a value from the drop down menu. |
Brand Id | brand_id | integer | Select a value from the drop down menu. |
Inventory Level | inventory_level | integer | Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect. >= 0 and <= 1000000000
|
Inventory Warning Level | inventory_warning_level | integer | Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect. >= 0 and <= 1000000000
|
Inventory Tracking | inventory_tracking | string | Select a value from the drop down menu:none product variant |
Fixed cost shipping price | fixed_cost_shipping_price | any | A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation. >= 0
|
Is free shipping | is_free_shipping | boolean | Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
|
Is visible | is_visible | boolean | Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
|
Is Featured | is_featured | boolean | Flag to determine whether the product should be included in the featured products panel when viewing the store.
|
Related Products | related_products | integer[] | Select a value from the drop down menu. |
Warranty | warranty | string | Warranty information displayed on the product page. Can include HTML formatting. >= 0 characters and <= 65535 characters
|
Bin picking number | bin_picking_number | string | The BIN picking number for the product. >= 0 characters and <= 255 characters
|
Layout File | layout_file | string | The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. >= 0 characters and <= 500 characters
|
UPC | upc | string | The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. >= 0 characters and <= 255 characters
|
Seach keywords | search_keywords | string | A comma-separated list of keywords that can be used to locate the product when searching the store. >= 0 characters and <= 65535 characters
|
Availability | availability | string | Select a value from the drop down menu:available disabled preorder |
Availability description | availability_description | string | Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' >= 0 characters and <= 255 characters
|
Gift wrapping options type | gift_wrapping_options_type | string | Select a value from the drop down menu:any none list |
Gift wrapping options list | gift_wrapping_options_list | string[] | A list of gift-wrapping option IDs.
|
Sort order | sort_order | integer | 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. >= -2147483648 and <= 2147483647
|
Condition | condition | string | Select a value from the drop down menu:New Used Refurbished |
Is condition shown | is_condition_shown | boolean | Flag used to determine whether the product condition is shown to the customer on the product page.
|
Order quantity minimum | order_quantity_minimum | integer | The minimum quantity an order must contain, to be eligible to purchase this product. >= 0 and <= 1000000000
|
Order quantity maximum | order_quantity_maximum | integer | The maximum quantity an order can contain when purchasing the product. >= 0 and <= 1000000000
|
Page title | page_title | string | Custom title for the product page. If not defined, the product name will be used as the meta title. >= 0 characters and <= 255 characters
|
Meta keywords | meta_keywords | string[] | Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
|
Meta description | meta_description | string | Custom meta description for the product page. If not defined, the store's default meta description will be used. >= 0 characters and <= 65535 characters
|
View count | view_count | integer | The number of times the product has been viewed. >= 0 and <= 1000000000
|
Preorder release date | preorder_release_date | string | Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
|
Preorder message | preorder_message | string | Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date. >= 0 characters and <= 255 characters
|
Is preorder only | is_preorder_only | boolean | 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. It will need to be changed manually either in the control panel or using the API. Using the API set availability to available.
|
Is preorder hidden | is_price_hidden | boolean | False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
|
Price hidden label | price_hidden_label | string | By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.) >= 0 characters and <= 200 characters
|
Open graph type | open_graph_type | string | Select a value from the drop down menu:product album book drink food game movie song tv_show |
Open graph title | open_graph_title | string | Title of the product, if not specified the product name will be used instead.
|
Open graph description | open_graph_description | string | Description to use for the product, if not specified then the meta_description will be used instead.
|
Open graph use meta description | open_graph_use_meta_description | boolean | Flag to determine if product description or open graph description is used.
|
Open graph use product name | open_graph_use_product_name | boolean | Flag to determine if product name or open graph name is used.
|
Open graph use image | open_graph_use_image | boolean | Flag to determine if product image or open graph image is used.
|
Brand name | brand_name | string | It performs a fuzzy match and adds the brand. eg. "Common Good" and "Common good" are the same. Brand name does not return as part of a product response. Only the brand_id.
|
GTIN | gtin | string | |
MPN | mpn | string | |
Reviews rating sum | reviews_rating_sum | any | The total rating for the product.
|
Reviews count | reviews_count | integer | The number of times the product has been rated.
|
Total sold | total_sold | integer | The total quantity of this product sold.
|
Images | images | string[] | Array of image strings. They can be either local paths or URLs. Limit of 8MB per file. If it is a URL it has a 255 character limit. Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP. If it is a local path it should be previously downloaded to Pipedream E.g. (/tmp/my-image.png ). Download a file to the /tmp directory
|