GET v1/Companies({CompanyId})/Entities({LocationId})/customers({CustomerId})/summary

Returns All the Loyalty Points for a Customer

Information:

Base URL:

https://api.covasoft.net/iqloyalty

Example of a call would be:

https://api.covasoft.net/iqloyalty/v1/Companies({CompanyId})/Entities({LocationId})/customers({CustomerId})/summary

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

The unique Company Id that was provided in your onboarding pacakage

 integer

Required
LocationId

The Location where you want Loyalty Rewards

 integer

Required
CustomerId

The Customer Id Guid that you want the Loyalty Rewards Summary

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Loyalty Points for a Customer

LoyaltyPointsByCustomerReturn
NameDescriptionTypeAdditional information
PointsBalance

integer

None.
LifetimePointsBalance

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "PointsBalance": 1,
  "LifetimePointsBalance": 2
}