ProductRules
Returns rules that modify the properties of a product, such as weight, price, and product image.
Table Specific Information
Select
The cmdlet uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:
- Id supports the = comparison.
- ProductId supports the = comparison.
The rest of the filter is executed client-side within the cmdlet.
For example, the following queries are processed server-side:
SELECT * FROM ProductRules WHERE Id = 1
SELECT * FROM ProductRules WHERE ProductId = 2
Columns
| Name | Type | References | Description |
| Id [KEY] | Integer | The ID of the rule. | |
| ProductId [KEY] | Integer |
Products.Id | The ID of the product to which the rule belongs. |
| SortOrder | Integer | The order in which the rule will be displayed on the product page. | |
| IsEnabled | Boolean | If set to true, the rule will be evaluated when a customer configures a products options. | |
| IsStop | Boolean | If set to true and the rule evaluates to true, no more rules with a higher sort_order will be processed. | |
| PriceAdjusterName | String | Price adjuster name. | |
| PriceAdjusterValue | Decimal | Price adjuster value. | |
| WeightAdjusterName | String | Weight adjuster name. | |
| WeightAdjusterValue | Decimal | Weight adjuster value. | |
| IsPurchasingDisabled | Boolean | If true this rule prohibits purchasing the product with the configured option values. | |
| PurchasingDisabledMessage | String | The message to display if the rule disabled purchasing the product. | |
| IsPurchasingHidden | Boolean | If true the rule hides the options on the product. | |
| ImageFile | String | A path to an rule already uploaded via FTP in the import directory and the path should be relative from the import directory. |