Skip to main content

Loyalty

Creating loyalty customer.#

URL:https://api.lingaros.com/v1/lingapos/customer

MethodTypeDescription
imageAvailableBoolCheck if an image is available.
firstNameStringCustomer first name.
lastNameStringCustomer last name.
emailIdStringCustomer e-mail address.
phoneNumberStringCustomer phone number.
genderStringCustomer gender.
dateOfBirthStringCustomer date of birth.
isLoyaltyCustomerBooleanCheck if loyalty customer.
addressLine1StringAddress line 1.
addressLine2StringAddress line 2.
cityStringCity information.
gateCodeStringGate code.
stateStringState information.
zipCodeStringZip code.
countryStringCountry information.
nationalityStringNationality code.
customerIdentificationNumberStringCustomer identification number.
accountStringAccount ID.
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"imageAvailable": false,
"firstName": "Loyalty",
"lastName": "Customer",
"emailId": "firstLoyaltyCustomer@mail.com",
"phoneNumber": "9876543216",
"gender": "Male",
"dateOfBirth": "03-Nov-2019",
"isLoyaltyCustomer": true,
"addressLine1": "XXXX",
"addressLine2": "YYYY",
"city": "Chennai",
"gateCode": "T, Anna Nagar",
"state": "TamilNadu",
"zipCode": "600040",
"country": "India",
"nationality": "Indian",
"customerIdentificationNumber": "#456",
"account": "5a8e8bff9230ca318b7b755c"
}' \
https://api.lingaros.com/v1/lingapos/customer\

Updating account loyalty information.#

URL:https://api.lingaros.com/v1/lingapos/account/{account_id}/updateAccountInfo

MethodTypeDescription
updateValueBoolCheck if the account is updated.
keyStringLoyalty update key.
optionIntLoyalty update option.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"updateValue": true,
"key": "hasCustomerLevelLoyalty",
"option": 3
}' \
https://api.lingaros.com/v1/lingapos/account/5a8e8bff9230ca318b7b755c/updateAccountInfo\

Creating loyalty customer.#

URL:https://api.lingaros.com/v1/lingapos/customer

MethodTypeDescription
imageAvailableBoolCheck if an image is available.
firstNameStringCustomer first name.
lastNameStringCustomer last name.
emailIdStringCustomer e-mail address.
phoneNumberStringCustomer phone number.
genderStringCustomer gender.
dateOfBirthStringCustomer date of birth.
isLoyaltyCustomerBooleanCheck if loyalty customer.
addressLine1StringAddress line 1.
addressLine2StringAddress line 2.
cityStringCity information.
gateCodeStringGate code.
stateStringState information.
zipCodeStringZip code.
countryStringCountry information.
nationalityStringNationality code.
customerIdentificationNumberStringCustomer identification number.
accountStringAccount ID.
curl -X POST \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"imageAvailable": false,
"firstName": "Loyalty",
"lastName": "Customer",
"emailId": "firstLoyaltyCustomer@mail.com",
"phoneNumber": "9876543216",
"gender": "Male",
"dateOfBirth": "03-Nov-2019",
"isLoyaltyCustomer": true,
"addressLine1": "XXXX",
"addressLine2": "YYYY",
"city": "Chennai",
"gateCode": "T, Anna Nagar",
"state": "TamilNadu",
"zipCode": "600040",
"country": "India",
"nationality": "Indian",
"customerIdentificationNumber": "#456",
"account": "5a8e8bff9230ca318b7b755c"
}' \
https://api.lingaros.com/v1/lingapos/customer\

Updating customer loyalty points.#

URL:https://api.lingaros.com/v1/lingapos/Customerloyalty/{customer_id}

MethodTypeDescription
accountStringAccount id.
loyaltyPointsIntCustomer loyalty points.
loyaltyReasonStringLoyalty points update reason.
loyaltyPointDifferenceIntLoyalty point difference.
adjustedByStringName of the employee who adjusted the loyalty points update.
curl -X PUT \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"account": "5a8e8bff9230ca318b7b755c",
"loyaltyPoints": 350,
"loyaltyReason": "Top Five Customer",
"loyaltyPointDifference": 340,
"adjustedBy": "Doe j"
}' \
https://api.lingaros.com/v1/lingapos/customerloyalty/5dbffafd278a2334f76a45a2\

Listing customer loyalty points change details.#

URL:https://api.lingaros.com/v1/lingapos/customer/{customer_id}/getCustomerLoyalties

MethodTypeDescription
dateStringDate of the loyalty information update.
ticketIDStringTicked ID.
typeStringLoyalty information update type.
amountIntAmount of loyalty point difference.
notesStringNotes.
curl -X GET \
-H "apikey: generated-api-key" \
-H "Content-Type: application/json" \
-d '{
"loyaltyDetails": [
{
"date": "04-Nov-2019",
"ticketID": "",
"type": "Enrollment",
"amount": "10.00",
"notes": ""
},
{
"date": "04-Nov-2019",
"ticketID": "",
"type": "ResetLoyalty",
"amount": "340.00",
"notes": ""
}
]
}' \
https://api.lingaros.com/v1/lingapos/customer/5dbffafd278a2334f76a45a2/getCustomerLoyalties\