This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Loyalty microservice.
External Events via EventBridge
The following events contain the entity changed in the event message payload.
List of Events
| S.No. | API call | Call detail | Event Type | Identifier |
|---|---|---|---|---|
| 1. | POST | CreateLoyaltyServiceImpl.java | loyaltyservices/loyalty/create | response_Loyalty.userId |
| 2. | PUT | UpdateLoyaltyServiceImpl.java | loyaltyservices/loyalty/update | response_Loyalty.userId |
| 3. | POST | CreateLoyaltyEvent | loyaltyservices/event/create | response_identifier |
| 4. | POST | CreateLoyaltyRewardServiceImpl.java | loyaltyservices/reward/create | response_Reward.identifier |
| 5. | POST | CreateRule | loyaltyservices/rule/create | response_response.response.id |
| 6. | POST | CreateTransactionServiceImpl.java | loyaltyservices/transaction/create | response_Transaction.identifier |
| 7. | PATCH | PatchUpdateRule | loyaltyservices/rule/patch | response_response.response.id |
| 8. | PUT | UpdateLoyaltyRewardServiceImpl.java | loyaltyservices/reward/update | response_Reward.identifier |
| 9. | PATCH | PatchUpdateLoyaltyEvent | loyaltyservices/event/patch | response_identifier |
| 10. | PUT | PutUpdateLoyaltyEvent | loyaltyservices/loyaltyevent/update | response_identifier |
| 11. | DELETE | DeleteRule | loyaltyservices/rule/delete | request_id |
| 12. | DELETE | DeleteLoyaltyRewardServiceImpl.java | loyaltyservices/reward/delete | response_Reward.identifier |
| 13. | DELETE | DeleteLoyaltyEvent | loyaltyservices/event/delete | request_identifier |
Payload
CreateLoyaltyService
Event Type: loyaltyservices/loyalty/create
{
"version": "0",
"id": "6866737e-d2b4-f656-91a3-b8b162fb1f5f",
"detail-type": "loyaltyservices/loyalty/create",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:04Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "UserId_17152404640865376",
"timestamp": 1715240464139,
"payload": {
"userId": "UserId_17152404640865376",
"collectionId": 635,
"blockRedemption": false,
"status": "ACTIVE",
"downgrade": false,
"cycleId": 1,
"cycleDate": 1715299200000,
"properties": [
{
"name": "Property1",
"value": "Value1",
"customProperty": false
}
],
"createdOn": 1715240464123,
"createdBy": 5,
"updatedOn": 1715240464123,
"updatedBy": 5,
"nextTierChangeDate": 0,
"nextExpirationDate": 0
},
"collectionId": "635",
"eventType": "loyaltyservices/loyalty/create",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateLoyaltyService
Event Type: loyaltyservices/loyalty/update
{
"version": "0",
"id": "0606e523-7e7d-f7db-3de3-31a059e37833",
"detail-type": "loyaltyservices/loyalty/update",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:08Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "UserId_SECOM42987_2792",
"timestamp": 1715240468312,
"payload": {
"userId": "UserId_SECOM42987_2792",
"collectionId": 425,
"blockRedemption": false,
"status": "INACTIVE",
"downgrade": false,
"cycleId": 1,
"cycleDate": 1715385600000,
"createdOn": 1715240468264,
"createdBy": 5,
"updatedOn": 1715240468305,
"updatedBy": 5,
"nextTierChangeDate": 0,
"nextExpirationDate": 0
},
"collectionId": "425",
"eventType": "loyaltyservices/loyalty/update",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
CreateLoyaltyEvent
Event Type: loyaltyservices/event/create
{
"version": "0",
"id": "83cf2012-d45f-30c7-7a0d-024b98934972",
"detail-type": "loyaltyservices/event/create",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:11Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e179d9fab317f6b3320",
"timestamp": 1715240471605,
"payload": {
"identifier": "663c7e179d9fab317f6b3320",
"collectionId": 635,
"name": "EventName_17152404715829482",
"description": "points",
"status": "ACTIVE",
"createdOn": 1715240471600,
"createdBy": 5,
"updatedOn": 1715240471600,
"updatedBy": 5,
"eventProperty": [
{
"name": "PropertyName_17152404715824154",
"value": "string",
"type": "STRING"
}
]
},
"collectionId": "635",
"eventType": "loyaltyservices/event/create",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
CreateLoyaltyReward
Event Type: loyaltyservices/reward/create
{
"version": "0",
"id": "c1288678-8953-3c00-67c7-4c97cd8bfd7c",
"detail-type": "loyaltyservices/reward/create",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:14Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e1a9d9fab317f6b3321",
"timestamp": 1715240474919,
"payload": {
"collectionId": 635,
"identifier": "663c7e1a9d9fab317f6b3321",
"type": "STARS",
"symbol": "p",
"status": "ACTIVE",
"blockEarning": false,
"blockRedemption": false,
"rewardApprovalRequired": true,
"createdOn": 1715240474914,
"createdBy": 5,
"updatedOn": 1715240474914,
"updatedBy": 5,
"manuallyAdded": false
},
"collectionId": "635",
"eventType": "loyaltyservices/reward/create",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
CreateRule
Event Type: loyaltyservices/rule/create
{
"version": "0",
"id": "89b7a22c-1ed1-dfc7-d512-db5a94b7c937",
"detail-type": "loyaltyservices/rule/create",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:18Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "BMTqhC",
"timestamp": 1715240478979,
"payload": {
"response": {
"collectionId": 635,
"response": {
"name": "create string",
"startTime": 2265618594000,
"endTime": 2518079394000,
"priority": 1,
"status": "INACTIVE",
"createdBy": 0,
"updatedBy": 0,
"id": "BMTqhC",
"ruleSetId": "hKymbJ",
"conditionData": {
"logicalOperator": "AND",
"conditions": [
{
"object": "customEvent",
"operand": "eventId",
"operator": "equal",
"value": "EventName_17152404715829482",
"type": "String"
},
{
"object": "customEvent",
"operand": "productPrice",
"operator": "equal",
"value": "500",
"type": "decimal",
"input": "text"
}
]
},
"event": "EventName_17152404715829482",
"actions": [
{
"name": "check action",
"className": "com.skava.loyalty.action.LoyaltyRewards",
"formula": "50",
"formulaTypes": "customEvent",
"rewardType": "STARS"
}
],
"ruleInformation": {
"description": [
{
"locale": "en_US",
"text": "string"
}
],
"message": [
{
"locale": "en_US",
"text": "string"
}
]
},
"stopFurtherProcessing": "NEVER",
"ruleType": 0,
"actionType": 0
}
}
},
"collectionId": "635",
"eventType": "loyaltyservices/rule/create",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
CreateTransaction
Event Type: loyaltyservices/transaction/create
{
"version": "0",
"id": "db866a81-de0c-be5d-23d5-0d7928f97407",
"detail-type": "loyaltyservices/transaction/create",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:24Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e249d9fab317f6b3323",
"timestamp": 1715240484315,
"payload": {
"collectionId": 635,
"userId": "UserId_17152404640865376",
"identifier": "663c7e249d9fab317f6b3323",
"type": "EARNED",
"cycleId": 1,
"rewardType": "STARS",
"expiryTime": 1918186985000,
"notes": "string",
"eventId": "EventName_17152404715829482",
"rewardValue": 1000.0,
"otrValue": 1000.0,
"storeId": "string",
"channel": "string",
"orderId": "string",
"balance": 0,
"industryTransactionId": "string",
"industryTransactionReference": "string",
"industryTransactionCode": "string",
"merchantId": "string",
"merchantName": "string",
"merchantCity": "string",
"merchantState": "string",
"merchantZipcode": "string",
"merchantClientID": "string",
"redemptionType": "string",
"redemptionKey": "string",
"redemptionValue": "string",
"redemptionVendor": "string",
"redemptionMethod": "string",
"redemptionVendorId": "string",
"effectiveDate": 1715240484294,
"properties": [
{
"name": "isAckRequired",
"value": "true"
},
{
"name": "additionalProp1",
"value": "string"
},
{
"name": "additionalProp2",
"value": "string"
},
{
"name": "additionalProp3",
"value": "string"
},
{
"name": "orderTotalValue",
"value": "0"
},
{
"name": "referenceID",
"value": "null"
},
{
"name": "orderTotalValue",
"value": "0"
},
{
"name": "referenceID",
"value": "null"
},
{
"name": "orderTotalValue",
"value": "0"
}
],
"startDate": 0,
"endDate": 0,
"createdOn": 1715240484298,
"createdBy": 5,
"updatedOn": 1715240484298,
"updatedBy": 5
},
"collectionId": "635",
"eventType": "loyaltyservices/transaction/create",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateRule
Event Type: loyaltyservices/rule/patch
{
"version": "0",
"id": "bcbd3524-1495-2b65-4601-3f95bf072761",
"detail-type": "loyaltyservices/rule/patch",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:28Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "X6kYcx",
"timestamp": 1715240488777,
"payload": {
"response": {
"collectionId": 635,
"response": {
"name": "create string",
"startTime": 2265618594000,
"endTime": 2518079394000,
"priority": 1,
"status": "INACTIVE",
"createdBy": 0,
"updatedBy": 0,
"id": "X6kYcx",
"ruleSetId": "iwYZJb",
"conditionData": {
"logicalOperator": "AND",
"conditions": [
{
"object": "customEvent",
"operand": "eventId",
"operator": "equal",
"value": "EventName_17152404876029718",
"type": "String"
},
{
"object": "customEvent",
"operand": "productPrice",
"operator": "equal",
"value": "500",
"type": "decimal",
"input": "text"
}
]
},
"event": "EventName_17152404876029718",
"actions": [
{
"name": "check action",
"className": "com.skava.loyalty.action.LoyaltyRewards",
"formula": "50",
"formulaTypes": "customEvent",
"rewardType": "STARS"
}
],
"ruleInformation": {
"description": [
{
"locale": "en_US",
"text": "string"
}
],
"message": [
{
"locale": "en_US",
"text": "string"
}
]
},
"stopFurtherProcessing": "NEVER",
"ruleType": 0,
"actionType": 0
}
}
},
"collectionId": "635",
"eventType": "loyaltyservices/rule/patch",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateLoyaltyReward
Event Type: loyaltyservices/reward/update
{
"version": "0",
"id": "00ca8629-88d4-45bf-71e6-edd239d54e02",
"detail-type": "loyaltyservices/reward/update",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:34Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e2e9d9fab317f6b3325",
"timestamp": 1715240494147,
"payload": {
"collectionId": 635,
"identifier": "663c7e2e9d9fab317f6b3325",
"type": "UpdateType_17152404941146915",
"symbol": "p",
"status": "ACTIVE",
"blockEarning": false,
"blockRedemption": false,
"rewardApprovalRequired": true,
"createdOn": 1715240494004,
"createdBy": 5,
"updatedOn": 1715240494142,
"updatedBy": 5,
"manuallyAdded": false
},
"collectionId": "635",
"eventType": "loyaltyservices/reward/update",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateLoyaltyEvent
Event Type: loyaltyservices/event/patch
{
"version": "0",
"id": "964ef1fc-5061-a7f6-1e31-98af223021dc",
"detail-type": "loyaltyservices/event/patch",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:39Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e179d9fab317f6b3320",
"timestamp": 1715240499466,
"payload": {
"identifier": "663c7e179d9fab317f6b3320",
"collectionId": 635,
"name": "EventName2_17152404994266598",
"description": "description_17152404994267018",
"status": "INACTIVE",
"createdOn": 1715240471600,
"createdBy": 5,
"updatedOn": 1715240499446,
"updatedBy": 5,
"eventProperty": [
{
"name": "PropertyName_17152404715824154",
"value": "string",
"type": "STRING"
},
{
"name": "propertyname",
"value": "Changedvlaue",
"type": "STRING"
}
]
},
"collectionId": "635",
"eventType": "loyaltyservices/event/patch",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
UpdateLoyaltyEvent
Event Type: loyaltyservices/loyaltyevent/update
{
"version": "0",
"id": "062be315-e2b1-5649-be17-1f2ecc2f2cfc",
"detail-type": "loyaltyservices/loyaltyevent/update",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:42Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e179d9fab317f6b3320",
"timestamp": 1715240502915,
"payload": {
"identifier": "663c7e179d9fab317f6b3320",
"collectionId": 635,
"name": "EventName_17152405028746230",
"description": "updatepoints",
"status": "ACTIVE",
"createdOn": 1715240502909,
"createdBy": 0,
"updatedOn": 1715240502909,
"updatedBy": 5,
"eventProperty": [
{
"name": "PropertyName_17152405028743867",
"value": "UpdateValue",
"type": "STRING"
}
]
},
"collectionId": "635",
"eventType": "loyaltyservices/loyaltyevent/update",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
DeleteRule
Event Type: loyaltyservices/rule/delete
{
"version": "0",
"id": "5a3a9233-2cc9-82de-5757-30797349d29e",
"detail-type": "loyaltyservices/rule/delete",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:46Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "BMTqhC",
"timestamp": 1715240506147,
"payload": {
"ruleSoftDeleteResponse": {
"collectionId": 635,
"response": {
"name": "create string",
"startTime": 2265618594000,
"endTime": 2518079394000,
"priority": 1,
"status": "INACTIVE",
"createdBy": 0,
"updatedBy": 0,
"id": "BMTqhC",
"ruleSetId": "hKymbJ",
"conditionData": {
"logicalOperator": "AND",
"conditions": [
{
"object": "customEvent",
"operand": "eventId",
"operator": "equal",
"value": "EventName_17152404715829482",
"type": "String"
},
{
"object": "customEvent",
"operand": "productPrice",
"operator": "equal",
"value": "500",
"type": "decimal",
"input": "text"
}
]
},
"event": "EventName_17152404715829482",
"actions": [
{
"name": "check action",
"className": "com.skava.loyalty.action.LoyaltyRewards",
"formula": "50",
"formulaTypes": "customEvent",
"rewardType": "STARS"
}
],
"ruleInformation": {
"description": [
{
"locale": "en_US",
"text": "string"
}
],
"message": [
{
"locale": "en_US",
"text": "string"
}
]
},
"stopFurtherProcessing": "NEVER",
"ruleType": 0,
"actionType": 0
}
}
},
"collectionId": "635",
"eventType": "loyaltyservices/rule/delete",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
DeleteLoyaltyReward
Event Type: loyaltyservices/reward/delete
{
"version": "0",
"id": "52968f47-110b-a12b-b220-a102aee61a87",
"detail-type": "loyaltyservices/reward/delete",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:49Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e1a9d9fab317f6b3321",
"timestamp": 1715240509493,
"payload": {
"loyaltyRewardDelete": {
"collectionId": 635,
"identifier": "663c7e1a9d9fab317f6b3321",
"type": "STARS",
"symbol": "p",
"status": "ACTIVE",
"blockEarning": false,
"blockRedemption": false,
"rewardApprovalRequired": true,
"createdOn": 1715240474914,
"createdBy": 5,
"updatedOn": 1715240509486,
"updatedBy": 5,
"manuallyAdded": false
}
},
"collectionId": "635",
"eventType": "loyaltyservices/reward/delete",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
DeleteLoyaltyEvent
Event Type: loyaltyservices/event/delete
{
"version": "0",
"id": "ad51c764-6b3f-5872-8558-0c2bb245c447",
"detail-type": "loyaltyservices/event/delete",
"source": "loyaltyservices",
"account": "277827593990",
"time": "2024-05-09T07:41:52Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"id": "663c7e409d9fab317f6b3327",
"timestamp": 1715240512792,
"payload": {
"loyaltyEventDelete": {
"identifier": "663c7e409d9fab317f6b3327",
"collectionId": 635,
"name": "EventName_17152405127483493",
"description": "points",
"status": "ACTIVE",
"createdOn": 1715240512762,
"createdBy": 5,
"updatedOn": 1715240512786,
"updatedBy": 0,
"eventProperty": [
{
"name": "PropertyName_17152405127486920",
"value": "string",
"type": "STRING"
}
]
}
},
"collectionId": "635",
"eventType": "loyaltyservices/event/delete",
"userId": "5",
"actOnBehalfOfUser": 0,
"roles": [
"ROLE_SUPER_ADMIN"
],
"channel": "CSR"
}
}
Internal Events via RabbitMQ/AWS MQ
The following events communicate with the internal microservices.
List of Events
| SL.# | NAME | DESCRIPTION | PUBLISH LOCATION | ROUTING KEY | DURABILITY | PAYLOAD TYPE |
|---|---|---|---|---|---|---|
| 1 | Create Transaction as Earn, Cycled, or Redeem | This event is triggered when creating a Earn, Cycled, or Redeem transaction. | Topic: ecomm | loyalty.transaction.create | FALSE | Transaction |
| 2 | Create or Update a Rule | This event is triggered when creating or updating a rule to clear the cache and reflect the changes in the API call. | Topic: ecomm | loyalty.rule.update | FALSE | cacheClear |
| 3 | Update Loyalty Points to the Order Service | This event updates the shipment and loyalty points earning details to the Order service. | Topic: ecomm | oms.omsReplyToQueue | FALSE | omsUpdate |
Payload Model
Below is the payload for the Loyalty microservice event:
Transaction
| 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 |
userId | string | Holds the user identifier. | User12378 |
identifier | String | Holds the identifier of the transaction. | T100 |
type | String | Holds the type of transaction. The value can be EARNED, APPROVED, FORFEITED, REDEEMED, RREVERSE-REDEEMED, CANCELED, UPDATED, EXPIRED, BLOCK-REDEEMED, or CYCLED. | EARNED |
status | String | Indicates the status of the transaction. The valid values are ACTIVE and INACTIVE. | ACTIVE |
parentTransactionId | String | Indicates the unique identifier of the parent transaction. | 63b6576266776814f654a8f1 |
cycleId | long | Indicates the cycle transaction ID. | 1 |
rewardType | String | Holds the reward type that is confirmed for earning points. | LOYALTY |
expiryTime | long | Indicates the transaction expiry time in milliseconds. | 1704430306990 |
notes | String | Specifies the description of the transaction. | Order Points |
eventId | String | Holds the event ID which is configured for earning the points. | Order Shipped |
otrValue | number | Specifies the open to redeem points earned in the transaction. | 100 |
childTransactions | JSON | Holds a list of parent transactions. It holds the loyalty EARNED transactions, which contains the identifier, rewardValue, and its type. | { |
orderId | String | Holds the order identifier. | 100 |
balance | number | Indicates the reward bank's total balance(open to redeem points) of the user. | 100 |
effectiveDate | String | Specifies the transaction effective date. It is mostly the current date (when a back dated order is placed, it holds the previous date). | 1672894306986 |
properties | JSON | Holds the transaction properties, which are added dynamically without affecting the exiting schema as key-value pairs. | [] |
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 transction in milliseconds. | 1516789034567 |
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 |
cacheClear
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
messageType | String | Indicates the type of action to be performed. After updating the rule, the cache is cleared to reflect the changes in the API call. | cacheClear |
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 |
authToken | String | Holds the authentication token of the user who has initiated the API. | eyJiaWQiOjAsImFsZyI6IkhTNTEyIn0.eyJjcmVhdGVkIjoxNTc2NjY2Nzk5Njk1LCJhY3Rpbmd1c2VybmFtZSI6IjAiLCJleHAiOjE1NzY2NzAzOTksImhhc2giOiJmZjZhZGMwYTZiYTJhYjM2NzhmMDIwZDU1MDNjMTE5NiIsImF1dGhvcml0aWVzIjoiW3tcInJvbGVzXCI6e1wiUk9MRV9TVVBFUl9BRE1JTlwiOnt9fX1dIiwidXNlcm5hbWUiOiIxIn0.7kX77xUvXl1uRSY88imE5ZcB4qpyw-zDSPOKqcKUxvWUJx6T2fkla2TN1FV6gyilhhecOWh3dJNhw9usx24uGQ |
omsUpdate
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
tier | String | Holds the user current tier information such as T1, T2, or T3. | Basic-5 |
pointValue | number | Indicates the point earned in the current order. | 7 |
rewardType | String | Specifies the reward type configured in the Loyalty Admin console. The reward types are configured in the collection property allowedRewardTypesForOptIn. | LOYALTY |
transactionType | String | Holds the transaction type created for the current order. | APPROVED |
shipmentDetails | JSON | Holds the shipment details received from the Order service, which is returned to the Order service to update the order math. It holds the item ID and its line item ID. | { |
Revision History
2024-05-22 | SD – Update the content for Event and Payload.
2023-01-09 | AN – Updated the content for 8.13 release.
2020-01-14 | AN – Updated content for February 2020 release.
2019-10-31 | AM – Content uploaded.
