Skip to content
/
Get affilicated package c...

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
support@sunlync.com
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Get client transaction history

Request

Returns a list trasnsactions for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
startdatestring(date)required
Examples:
startdate=2025-01-01
enddatestring(date)required
Examples:
enddate=2025-01-01
includedetailintegerrequired
Examples:
includedetail=1
trantypesstring
Examples:
trantypes=T,R,M,P
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/transactionhistory?clientnumber=stringstri&startdate=2019-08-24&enddate=2019-08-24&includedetail=0&trantypes=string'

Responses

Get a list of tranactions

Bodyapplicaiton/json
transactionsArray of objects(transactions)
Response
applicaiton/json
{
  "transactions": [
    { … }
  ]
}

Get affilicated package clients

Request

Returns a list of clients sharing an affiliated package by given membership id

Security
BasicAuthCredentials
Query
membershipidstring= 10 charactersrequired
Examples:
membershipid=0000000001
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/setup/affiliatedpackageclients?membershipid=stringstri'

Responses

Get affilicated package clients

Bodyapplicaiton/json
clientsArray of objects(affiliatedpackageclients)
Response
applicaiton/json
{
  "clients": [
    { … }
  ]
}

Insert client

Request

Inserts a client and returns client number

  • storecode is the storecode of the store location
  • empNo is the employee number of the employee inserting the client
Security
BasicAuthCredentials
Bodyapplication/json
firstNamestring
Example: "John"
lastNamestring
Example: "Doe"
middleInitstring
Example: "D"
address1string
Example: "1 Main st"
address2string
Example: "Suite 10"
citystring
Example: "Buffalo"
statestring
Example: "NY"
zipstring
Example: "14220"
homePhonestring
Example: "7165551234"
workPhonestring
Example: "7165555678"
cellPhonestring
Example: "7165550987"
emailstring
Example: "test@test.com"
dobstring(date)
Example: "1980-12-25"
storecodestring
Example: "0000000001"
empNostring
Example: "0000000001"
genderstring
Example: "female"
doNotSolicitinteger
Example: 0
emailCommPrefinteger
Example: 1
cellVoiceCommPrefinteger
Example: 1
cellTextCommPrefinteger
Example: 1
homePhoneCommPrefinteger
Example: 1
mailCommPrefinteger
Example: 1
workPhoneCommPrefinteger
Example: 1
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insert \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "middleInit": "D",
    "address1": "1 Main st",
    "address2": "Suite 10",
    "city": "Buffalo",
    "state": "NY",
    "zip": "14220",
    "homePhone": "7165551234",
    "workPhone": "7165555678",
    "cellPhone": "7165550987",
    "email": "test@test.com",
    "dob": "1980-12-25",
    "storecode": "0000000001",
    "empNo": "0000000001",
    "gender": "female",
    "doNotSolicit": 0,
    "emailCommPref": 1,
    "cellVoiceCommPref": 1,
    "cellTextCommPref": 1,
    "homePhoneCommPref": 1,
    "mailCommPref": 1,
    "workPhoneCommPref": 1
  }'

Responses

Inserts a client

Bodyapplicaiton/json
clientNumberstring
Example: "0000000001"
messagestring
Example: ""
Response
applicaiton/json
{
  "clientNumber": "0000000001",
  "message": ""
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations