The Shireburn Business Suite (SBS) API enables you to interact with SBS systems. You will need an API key which should be passed as a query string with each of the requests below.

GET api/Loyalty/GetCustomerGroupRates?companyKey={companyKey}

Gets the list point rates per customer group.

Request Information

URI Parameters

Name	Description	Type	Additional information
companyKey		string	Default value is

Body Parameters

N/A

Response Information

Resource Description

Collection of CustomerGroupRate

Name	Description	Type	Additional information
GroupCode	The customer group code.	string	N/A
CompNo	The company number.	integer	N/A
ApAmt	The points allocation amount (in base currency) required to allocate 1 point. For example, 1 point is allocated with every €50 is spent, where €50 is the ApAmt.	decimal number	N/A
RpAmt	The amount given (in base currency) when 1 point is redeemed. For example, €2 is given when 1 point is redeemed, where €2 is the RpAmt.	decimal number	N/A
Rounding	The rounding to be used when allocating points. There are 3 possible values: Standard (S), Round Up (U), and Round Down (D).	string	N/A
Uid		string	N/A

Response Formats

application/json, text/json

Sample:

[
  {
    "GroupCode": "sample string 1",
    "CompNo": 2,
    "ApAmt": 3.0,
    "RpAmt": 4.0,
    "Rounding": "sample string 5",
    "Uid": "sample string 6"
  },
  {
    "GroupCode": "sample string 1",
    "CompNo": 2,
    "ApAmt": 3.0,
    "RpAmt": 4.0,
    "Rounding": "sample string 5",
    "Uid": "sample string 6"
  }
]