This page provides the event and associated payload for the Loyalty microservice.

Event

SL.#NAMEDESCRIPTIONPUBLISH LOCATIONROUTING KEYDURABILITYPAYLOAD TYPE
1Redemption Child Transaction UpdateThis event is triggered when a redemption transaction is created.Topic: ecommloyalty.transaction.createFALSEEvent
2Validate Cycle Math calculationThis event is triggered when a cycle transaction is created.Topic: ecommloyalty.transaction.createFALSEEvent

Payload Model

Below is the payload for the Loyalty microservice event:

Event

PROPERTYTYPEDESCRIPTIONEXAMPLE
collectionIdlongIndicates the ID of the collection. In all the microservices, the configuration parameters of the APIs are maintained in an entity called collection. You can customize the functionality of the API using the collection properties. It is a mandatory parameter for all the microservices. The value should not be empty or null. It should be greater than 0. There is no specific range applicable for the value.100
createdBylongHolds the user identifier who has created this entry. This is a unique identifier which can be used to identify a user. This data is generated and maintained by the User microservice and logically referred in this microservice.56
createdOnlongIndicates the created time of the event in milliseconds.1516789034567
descriptionStringHolds the description of the loyalty event.Event for user sign up.
eventPropertyHolds a list of event properties of a particular loyalty event.{
"name": "Product Name",
"type": "STRING",
"value": "product.productName"
}
identifierStringHolds the unique identifier of the loyalty event.5aaa1c5a97a1c0000f15a911
nameStringHolds the name of the loyalty event. The name can hold the following special characters -!@#$%&*_:. and the alphanumeric characters. The maximum length of the name is 50.SignUp
statusStringHolds the status of the loyalty event. It includes both ACTIVE or INACTIVE entities.ACTIVE
updatedBylongHolds the user identifier who has updated this entry lastly. This is a unique identifier which can be used to identify a user. This data is generated and maintained by the User microservice and logically referred in this microservice.56
updatedOnlongHolds the last updated timestamp of this entry. It is specified using the format: YYYY-MM-DD HH:MM:SS.1516989034567
authTokenStringHolds the authentication token of the user, who has initiated the API.eyJiaWQiOjAsImFsZyI6IkhTNTEyIn0.eyJjcmVhdGVkIjoxNTc2NjY2Nzk5Njk1LCJhY3Rpbmd1c2VybmFtZSI6IjAiLCJleHAiOjE1NzY2NzAzOTksImhhc2giOiJmZjZhZGMwYTZiYTJhYjM2NzhmMDIwZDU1MDNjMTE5NiIsImF1dGhvcml0aWVzIjoiW3tcInJvbGVzXCI6e1wiUk9MRV9TVVBFUl9BRE1JTlwiOnt9fX1dIiwidXNlcm5hbWUiOiIxIn0.7kX77xUvXl1uRSY88imE5ZcB4qpyw-zDSPOKqcKUxvWUJx6T2fkla2TN1FV6gyilhhecOWh3dJNhw9usx24uGQ

 

 


Revision History
2020-01-14 | Ananthi – Updated content for February 2020 release.
2019-10-31 | Mary – Content uploaded.