Skip to content
/
Insert gift certificate

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

Insert client membership

Request

Inserts a client membership

  • storecode is the storecode of the store location
  • empNo is the employee number of the employee inserting the client
  • drawDay must be value returned by the getEFTDrawDays endpoint
Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipNumberstring
Example: "0000000001"
storecodestring
Example: "0000000001"
employeeNumberstring
Example: "0000000001"
drawDaystring
Example: "01"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertMembership \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipNumber": "0000000001",
    "storecode": "0000000001",
    "employeeNumber": "0000000001",
    "drawDay": "01"
  }'

Responses

Inserts a client membership

Bodyapplicaiton/json
messagestring
Example: ""
membershipIdstring
Example: ""
Response
applicaiton/json
{
  "message": "",
  "membershipId": ""
}

Insert gift certificate

Request

Insert Gift Certificate

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
amountnumber(:float)
Example: 10
giftCertNostring
Example: "123456789"
receiptNostring
Example: "0000009878"
employeeNumberstring
Example: "0000000001"
storecodestring
Example: "0000000001"
notestring
Example: "This is a test note"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertgiftcert \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "amount": 10,
    "giftCertNo": "123456789",
    "receiptNo": "0000009878",
    "employeeNumber": "0000000001",
    "storecode": "0000000001",
    "note": "This is a test note"
  }'

Responses

Insert Gift Certificate

Bodyapplicaiton/json
messagestring
Example: ""
Response
applicaiton/json
{
  "message": ""
}

Freeze membership

Request

Freezes an active eft membership

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipIdstring
Example: "0000000001"
nextDuesAmountnumber(float)
Example: 5
freezeDatestring(date)
Example: "2025-08-01"
freezeMonthsinteger
Example: 12
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/freezemembership \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipId": "0000000001",
    "nextDuesAmount": 5,
    "freezeDate": "2025-08-01",
    "freezeMonths": 12
  }'

Responses

Membership updated

Bodyapplicaiton/json
messagestring
Example: ""
membershipIdstring
Example: "0000000001"
Response
applicaiton/json
{
  "message": "",
  "membershipId": "0000000001"
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations