Categories
Returns Product Categories.
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 '=,<=,>=,<,>,IN, and NOT_IN' comparisons.
- ParentId supports the '=,<=,>=,<,>,IN, and NOT_IN' comparisons.
- Name supports the '= and LIKE' comparison.
- PageTitle supports the '= and LIKE' comparison.
- IsVisible 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 Categories WHERE Id = 18 SELECT * FROM Categories WHERE Id >= 18 AND Id <= 25 SELECT * FROM Categories WHERE Name = "test"
Insert
To insert a new Categories, you need to specify at least the following columns: ParentId,Name, and Description.
INSERT INTO Categories (ParentId,Name,Description) VALUES (27,'Car Interior121', 'Accessories for testing car.')
Update
UPDATE Categories SET Description='Testing123' where id=18
Delete
DELETE FROM Categories WHERE Id = 18
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Integer | True |
The Id of this product category. | |
ParentId | Integer | False |
Categories.Id |
The Id of the category. |
Name | String | False |
Name of the this category. | |
Description | String | False |
System name of the type of order status. | |
Views | Integer | False |
Number of views the category has on the storefront. | |
SortOrder | Integer | False |
Priority this category will be given when included in the menu and category pages. | |
PageTitle | String | False |
Custom title for the category page. | |
MetaKeywords | String | False |
Custom meta keywords for the category page. | |
MetaDescription | String | False |
Custom meta description for the category page. | |
LayoutFile | String | False |
A valid layout file. | |
ImageUrl | String | False |
Image URL used for this category on the storefront. | |
IsVisible | Boolean | False |
Flag to determine whether the product should be displayed to customers browsing the store. | |
SearchKeywords | String | False |
A comma-separated list of keywords that can be used to locate the category when searching the store. | |
DefaultProductSort | String | False |
Determines how the products are sorted on category page load. | |
UrlPath | String | False |
URL Path. | |
IsCustomized | Boolean | False |
Flag to determine whether the url is customized. |