Cmdlets for BigCommerce

Build 24.0.9060

CustomerGroups

Returns a list of Customer Groups.

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.
  • Name supports the '=' comparison.
  • IsDefault supports the '=' comparison.
  • IsGroupForGuests 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 CustomerGroups WHERE Id = 1 

SELECT * FROM CustomerGroups WHERE IsDefault = "true"

SELECT * FROM CustomerGroups WHERE IsGroupForGuests = "true"

Columns

Name Type References Description
Id [KEY] Integer Id of the customer group
Name String Name of the group
IsDefault Boolean Determines whether new customers are assigned to this group by default.
CategoryAccessType String Type of the category access.
CategoryAccessCategories String An array of category IDs.
IsGroupForGuests Boolean Describes whether the group is for guests. There can only be one customer group for guests at a time.
DateCreated Date Date on which the customer group was created.
DateModified Date Date on which the customer group was last modified.
DiscountRulesAmount String A collection of discount rules that are automatically applied to customers who are members of the group.

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