This page provides the event and associated payload for the Loyalty microservice.
Event
| SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
|---|---|---|---|---|---|---|
| 1 | Redemption Child Transaction Update | This event is triggered when a redemption transaction is created. | Topic: ecomm | loyalty.transaction.create | FALSE | Event |
| 2 | Validate Cycle Math calculation | This event is triggered when a cycle transaction is created. | Topic: ecomm | loyalty.transaction.create | FALSE | Event |
Payload Model
Below is the payload for the Loyalty microservice event:
Event
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates 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 |
createdBy | long | Holds 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 |
createdOn | long | Indicates the created time of the event in milliseconds. | 1516789034567 |
description | String | Holds the description of the loyalty event. | Event for user sign up. |
eventProperty | Holds a list of event properties of a particular loyalty event. | { "name": "Product Name", "type": "STRING", "value": "product.productName" } |
|
identifier | String | Holds the unique identifier of the loyalty event. | 5aaa1c5a97a1c0000f15a911 |
name | String | Holds 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 |
status | String | Holds the status of the loyalty event. It includes both ACTIVE or INACTIVE entities. | ACTIVE |
updatedBy | long | Holds 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 |
updatedOn | long | Holds the last updated timestamp of this entry. It is specified using the format: YYYY-MM-DD HH:MM:SS. | 1516989034567 |
authToken | String | Holds the authentication token of the user, who has initiated the API. | eyJiaWQiOjAsImFsZyI6IkhTNTEyIn0.eyJjcmVhdGVkIjoxNTc2NjY2Nzk5Njk1LCJhY3Rpbmd1c2VybmFtZSI6IjAiLCJleHAiOjE1NzY2NzAzOTksImhhc2giOiJmZjZhZGMwYTZiYTJhYjM2NzhmMDIwZDU1MDNjMTE5NiIsImF1dGhvcml0aWVzIjoiW3tcInJvbGVzXCI6e1wiUk9MRV9TVVBFUl9BRE1JTlwiOnt9fX1dIiwidXNlcm5hbWUiOiIxIn0.7kX77xUvXl1uRSY88imE5ZcB4qpyw-zDSPOKqcKUxvWUJx6T2fkla2TN1FV6gyilhhecOWh3dJNhw9usx24uGQ |
Revision History
2020-01-14 | AN – Updated content for February 2020 release.
2019-10-31 | AM – Content uploaded.
