Categories
Returns Product Categories.
Table Specific Information
Select
The connector 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 comparisons.
- PageTitle supports the = and LIKE comparisons.
- IsVisible supports the = comparison.
- TreeId supports the =, IN, and NOT_IN comparisons.
- CategoryUUID supports the =, IN, and NOT_IN comparisons.
The rest of the filter is executed client-side within the connector.
For example, the following queries are processed server-side:
SELECT * FROM Categories WHERE Id = 18;
SELECT * FROM Categories WHERE Id IN (19,20);
SELECT * FROM Categories WHERE Id NOT IN (19,20);
SELECT * FROM Categories WHERE Name = "test";
SELECT * FROM Categories WHERE Name LIKE "%test%";
Insert
To insert a category, specify at least the following columns: ParentId, Name, TreeId and Description.
INSERT INTO Categories (ParentId, Name, Description, TreeId) VALUES (27, 'Car Interior121', 'Accessories for testing car.', 1);
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 |
Unique ID of the Category. | |
| ParentId | Integer | False |
Categories.Id |
The unique numeric ID of the category parent. |
| Name | String | False |
The name displayed for the category. Name is unique with respect to the categoryʼs siblings. | |
| Description | String | False |
The product description, which can include HTML formatting. | |
| 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. | |
| TreeId | Integer | False |
The ID of the category tree. | |
| CategoryUUID | String | True |
An additional unique identifier for the category. |