CustomerGroups

Returns customer groups, including category access and discount rule details.

Table-Specific Information

Select

The component uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = operator.
Name supports the = and LIKE operators.
IsDefault supports the = operator.
IsGroupForGuests supports the = operator.
DateModified supports the =, <=, >=, <, and > operators.

The rest of the filter is executed client-side within the component. For example, the following queries are processed server-side:

SELECT * FROM CustomerGroups WHERE Id = 1 

SELECT * FROM CustomerGroups WHERE IsDefault = "true"

SELECT * FROM CustomerGroups WHERE IsGroupForGuests = "true"

SELECT * FROM CustomerGroups WHERE DateModified = '2024-12-27 01:20:31.0'

SELECT * FROM CustomerGroups WHERE DateModified <= '2024-12-27 01:20:31.0'

Insert

To insert a customer group, specify at least the following column: Name.

INSERT INTO CustomerGroups (Name, IsGroupForGuests, IsDefault) VALUES ('Testing CustomerGroups 1', True, False)

Update

The following is an example of how to update the CustomerGroups table:

UPDATE CustomerGroups SET IsGroupForGuests = False WHERE Id = 6

Delete

The following is an example of how to delete from the CustomerGroups table:

DELETE FROM CustomerGroups WHERE Id = '5'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The unique identifier of the customer group.
Name	String	False	The name of the customer group.
IsDefault	Boolean	False	Indicates whether new customers are automatically assigned to this group by default.
CategoryAccessType	String	False	The type of category access. Possible values are: all, specific, none.
CategoryAccessCategories	String	False	The array of category Ids associated with the customer group's category access.
IsGroupForGuests	Boolean	False	Indicates whether the group is for guests. There can only be one customer group for guests at a time.
DateCreated	Datetime	True	The date on which the customer group was created.
DateModified	Datetime	True	The date on which the customer group was last modified.
DiscountRules	String	False	The collection of discount rules that are automatically applied to customers who are members of the group.