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/GetCustomerByCode?code={code}&companyKey={companyKey}

Retrieves a Loyalty customer by code.

Request Information

URI Parameters

Name	Description	Type	Additional information
code	The customer code.	string	Required
companyKey		string	Default value is

Body Parameters

N/A

Response Information

Resource Description

A customer.

Customer

Name	Description	Type	Additional information
CustRef	The customer reference.	string	Required Max length: 10
Code	The customer code.	string	Required Max length: 10
Name	The customer's name.	string	Required Max length: 200
Address1		string	Max length: 100
Address2		string	Max length: 100
Address3		string	Max length: 100
Town		string	Max length: 30
Country		string	Max length: 30
Phone		string	Max length: 17
Fax		string	Max length: 17
Mobile		string	Max length: 17
IdNo		string	Max length: 10
Email		string	Max length: 254
ContTitle	The customer's contact title.	string	Max length: 10
ContName	The customer's contact name.	string	Max length: 100
ContSurn	The customer's contact surname.	string	Max length: 100
Group		string	Required Max length: 4
MaxDisc	The maximum discount amount allowed for this customer.	decimal number	N/A
Discount	The discount percentage applied by default in sales transactions for this customer.	decimal number	N/A
LastSale	The last sale date.	date	N/A
LastRDmp	Last Redemption date.	date	N/A
EuCountry	The first 2 letters of the customer's VAT Registration number (e.g. MT)	string	Max length: 2
VatReg	The customer's VAT registration number. This should exclude the first 2-letter EU country code.	string	Max length: 12
OnHold	Determines whether the customer is on hold or not.	boolean	N/A
Remark		string	Max length: 50
Created		date	N/A
Points		integer	N/A
CreatedBy		string	N/A
AmendedBy		string	N/A
LastAmend		date	N/A
Uid		string	Required
Active		boolean	N/A
Cancelled		boolean	N/A
BirthDate		date	N/A
Interest1		string	Max length: 30
Interest2		string	Max length: 30
Locality		string	Max length: 4
PostalCode		string	Max length: 10
CardMngr		string	Required Max length: 10
CardNo		string	Max length: 25
Rounding		string	Max length: 1

Response Formats

application/json, text/json

Sample:

{
  "CustRef": "sample string 1",
  "Code": "sample string 2",
  "Name": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "Address3": "sample string 6",
  "Town": "sample string 7",
  "Country": "sample string 8",
  "Phone": "sample string 9",
  "Fax": "sample string 10",
  "Mobile": "sample string 11",
  "IdNo": "sample string 12",
  "Email": "sample string 13",
  "ContTitle": "sample string 14",
  "ContName": "sample string 15",
  "ContSurn": "sample string 16",
  "Group": "sample string 17",
  "MaxDisc": 19.0,
  "Discount": 20.0,
  "LastSale": "2024-10-06T02:33:56.8899171",
  "LastRDmp": "2024-10-06T02:33:56.8899171",
  "EuCountry": "sample string 21",
  "VatReg": "sample string 22",
  "OnHold": true,
  "Remark": "sample string 24",
  "Created": "2024-10-06T02:33:56.8899171",
  "Points": 26,
  "CreatedBy": "sample string 27",
  "AmendedBy": "sample string 28",
  "LastAmend": "2024-10-06T02:33:56.8899171",
  "Uid": "sample string 31",
  "Active": true,
  "Cancelled": true,
  "BirthDate": "2024-10-06T02:33:56.8899171",
  "Interest1": "sample string 35",
  "Interest2": "sample string 36",
  "Locality": "sample string 37",
  "PostalCode": "sample string 38",
  "CardMngr": "sample string 39",
  "CardNo": "sample string 40",
  "Rounding": "sample string 43"
}