GET api/CustomerGroups/GetCustomerGroups?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all Customer groups. Pagination is supported.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageIndex		integer	None.
pageSize		integer	None.

Body Parameters

None.

Response Information

Resource Description

GetCustomerGroupsResult

Name	Description	Type	Additional information
PagedCustomerGroups	A page with Customer group rows.	GetCustomerGroupResult	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedCustomerGroups": {
    "PageIndex": 0,
    "PageSize": 10,
    "TotalItems": 2,
    "TotalPages": 1,
    "Items": [
      {
        "Id": 1,
        "Name": "VIP",
        "Color": "#ffffff",
        "Description": "Our best customers"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetCustomerGroupsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedCustomerGroups>
    <Items>
      <GetCustomerGroupResult>
        <Color>#ffffff</Color>
        <Description>Our best customers</Description>
        <Id>1</Id>
        <Name>VIP</Name>
      </GetCustomerGroupResult>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <TotalItems>2</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedCustomerGroups>
</GetCustomerGroupsResult>