Cmdlets for BigCommerce

Build 24.0.9060

ProductOptions

Returns data from Products table.

Table Specific Information

Select


SELECT * FROM ProductOptions

Insert

To insert a new ProductOption, a set of OptionValues are required to be inserted along with it. This can be done by populating a temporary ProductOptionValues table with the desired values for the option you are creating, and later using this table as a value for the LinkedOptionValues Pseudo-Columns during insertion:

INSERT INTO ProductOptionValues#TEMP (Label, SortOrder, IsDefault) VALUES ('Classic', 0, true);
INSERT INTO ProductOptionValues#TEMP (Label, SortOrder, IsDefault) VALUES ('Elegance', 1, false);
INSERT INTO ProductOptionValues#TEMP (Label, SortOrder, IsDefault) VALUES ('Avantgarde', 2, false);
INSERT INTO ProductOptions (ProductId, DisplayName, Type, Name, SortOrder, LinkedOptionValues) VALUES (955, 'ModelSeries', 'dropdown', 'Series', 0, ProductOptionValues#TEMP);

Update


UPDATE ProductOptions SET DisplayName='Testing123' where Id=109

Delete


DELETE FROM ProductOptions WHERE Id = 3

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

The ID of the option.

ProductId [KEY] Integer True

Products.Id

The ID of the product.

DisplayName String False

The name of the option shown on the storefront.

Name String False

The unique option name, auto-generated from the display name, a timestamp, and the product ID.

Type String False

The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch.

SortOrder Integer False

The order in which the option will be displayed on the product page.

ConfigDefaultValue String False

The default value. Shown on a date option as an ISO-8601�formatted string, or on a text option as a string.

ConfigCheckedByDefault Boolean False

Flag for setting the checkbox to be checked by default.

ConfigCheckboxLabel String False

Label displayed for the checkbox option.

ConfigDateLimited Boolean False

Flag to limit the dates allowed to be entered on a date option.

ConfigDateLimitMode String False

The type of limit that is allowed to be entered on a date option.

The allowed values are earliest, range, latest.

ConfigDateEarliestValue String False

The earliest date allowed to be entered on the date option, as an ISO-8601 formatted string.

ConfigDateLatestValue String False

The latest date allowed to be entered on the date option, as an ISO-8601 formatted string.

ConfigFileTypesMode String False

The kind of restriction on the file types that can be uploaded with a file upload option. Values: specific - restricts uploads to particular file types; all - allows all file types.

The allowed values are specific, all.

ConfigFileTypesSupported String False

The type of files allowed to be uploaded if the file_type_option is set to specific.

ConfigFileTypesOther String False

A list of other file types allowed with the file upload option.

ConfigFileMaxSize Integer False

The maximum size for a file that can be used with the file upload option. This will still be limited by the server.

ConfigTextCharactersLimited Boolean False

Flag to validate the length of a text or multi-line text input.

ConfigTextMinLength Integer False

The minimum length allowed for a text or multi-line text option.

ConfigTextMaxLength Integer False

The maximum length allowed for a text or multi line text option.

ConfigTextLinesLimited Boolean False

Flag to validate the maximum number of lines allowed on a multi-line text input.

ConfigTextMaxLines Integer False

The maximum number of lines allowed on a multi-line text input.

ConfigNumberLimited Boolean False

Flag to limit the value of a number option.

ConfigNumberLimitMode String False

The type of limit on values entered for a number option.

The allowed values are lowest, highest, range.

ConfigNumberLowestValue Integer False

The lowest allowed value for a number option if number_limited is true.

ConfigNumberHighestValue Integer False

The highest allowed value for a number option if number_limited is true.

ConfigNumberIntegersOnly Boolean False

Flag to limit the input on a number option to whole numbers only.

ConfigProductListAdjustsInventory Boolean False

Flag for automatically adjusting inventory on a product included in the list.

ConfigProductListAdjustsPricing Boolean False

Flag to add the optional product's price to the main product's price.

ConfigProductListShippingCalc String False

How to factor the optional product's weight and package dimensions into the shipping quote.

The allowed values are none, weight, package.

Pseudo-Columns

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
LinkedOptionValues String

Column for the aggregate table name holding option values.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060