Events – SFO

This page provides the list of events and associated payloads for the Storefront Orchestration microservice.

List of Events

Name	Description	Publish Location	Routing Key	Durability	Payload Type
User Registration (B2C)	This event will be triggered when a user is registered successfully. It has complete information about the user.	ecomm	user.usercreated	true	USER_USERCREATED
Invite User (B2C)	This event will be triggered when a user is invited again successfully. It has the user information like user ID, email ID, phone number, first name, and last name.	ecomm	user.usercreated	true	USER_INVITEUSER
Reset Password (B2C)	This event will be triggered when a user is trying to reset the password. It has the user information like email ID and phone number.	ecomm	user.resetpassword	true	USER_RESET_CREDENTIAL
Accounts User Registration (B2B)	This event will be triggered when a user is registered successfully. It has complete information about the user.	ecomm	user.usercreated	true	ACCOUNTS_WELCOMEUSER
Accounts Invite User (B2B)	This event will be triggered when a user is invited again successfully. It has the user information like user ID, email ID, phone number, first name, and last name.	ecomm	user.usercreated	true	ACCOUNTS_INVITEUSER
List Share (B2C)	This event will be triggered when a user shares the list (Favorites).	ecomm		true	LIST_SHARE
Order Confirmation	This event will be triggered when an order is created.	ecomm	order.created	true	ORDER_CONFIRMATION
Add Loyalty Appeasement	This event is triggered when a customer is appeased with a reward.	ecomm	loyalty.transaction.create	false	LOYALTY_TRANSACTION
Earn Loyalty	This event is triggered when a customer earns a reward.	ecomm	loyalty.transaction.create	false	LOYALTY_TRANSACTION
Redeem Loyalty	This event is triggered when a customer redeems a reward.	ecomm	loyalty.transaction.create	false	LOYALTY_TRANSACTION

Payload Models

Below are the payloads for the Storefront Orchestration microservice.

USER_USERCREATED

Property	Type	Description	Example
collectionId	long	Indicates the unique ID of the collection.	1
users.id	long	Indicates the ID of the user.	211
users.email	string	Indicates the unique email address of the user.	user@skava.com
users.phoneNumber	string	Holds the unique phone number of the user.	1675212054
users.firstName	string	Indicates the first name of the user.	Mannix
users.lastName	string	Indicates the last name of the user.	Bruce
users.status	string	Indicates the status of the user.	ACTIVE
users.type	string	Indicates the user type, such as a guest user or a registered user.	1
users.gender	string	Indicates the gender of the user.	male
users.photo	string	Holds the uploaded image URL of the user's profile photo.	Sample 3
users.dateOfBirth	string	Indicates the user's date of birth.	10/12/2000
users.resetParam	string	Indicates the reset parameter, which is received through the email or SMS.
users.activationParam	string	Indicates the activation param, which is used to activate the user.
users.preferences	string	Indicates the user's preferences, which are either email or phone number.	sms
users.createdDate	Date	Indicates the created timestamp of the user.	1543406415000
users.updatedDate	Date	Indicates the updated timestamp of the user.	1543406415000
users.addressess	list	Refers to the list of user's address.
users.userConsents	list	Refers to the list of user consent details.
resetPasswordRedirectUrl	string	Indicates the redirect URL of the site, which is used to reset the user password.
activationRedirectUrl	string	Indicates the redirect URL of the site, which is used to activate the user.
activationParamExpiryMillisec	string	Refers to the expiry time (in millisecond) of the user's activation parameter.	86400000
resetParamExpiryMillisec	long	Refers to the expiry time (in millisecond) of the user's reset parameter.	86400000
inviteUserFlag	boolean	Indicates whether an invite email or a welcome email needs to be sent or not.	false

USER_INVITEUSER

Property	Type	Description	Example
collectionId	long	Indicates the unique ID of the collection.	1
users.id	long	Indicates the ID of the user.	211
users.email	string	Indicates the unique email address of the user.	user@skava.com
users.phoneNumber	string	Holds the unique phone number of the user.	1675212054
users.firstName	string	Indicates the first name of the user.	Mannix
users.lastName	string	Indicates the last name of the user.	Bruce
users.status	string	Indicates the status of the user.	ACTIVE
users.type	string	Indicates the user type, such as a guest user or a registered user.	1
users.gender	string	Indicates the gender of the user.	male
users.photo	string	Holds the uploaded image URL of the user's profile photo.	Sample 3
users.dateOfBirth	string	Indicates the user's date of birth.	10/12/2000
users.resetParam	string	Indicates the reset parameter, which is received through the email or SMS.
users.activationParam	string	Indicates the activation param, which is used to activate the user.
users.preferences	string	Indicates the user's preferences, which are either email or phone number.	sms
users.createdDate	Date	Indicates the created timestamp of the user.	1543406415000
users.updatedDate	Date	Indicates the updated timestamp of the user.	1543406415000
users.addressess	list	Refers to the list of user's address.
users.userConsents	list	Refers to the list of user consent details.
resetPasswordRedirectUrl	string	Indicates the redirect URL of the site, which is used to reset the user password.
activationRedirectUrl	string	Indicates the redirect URL of the site, which is used to activate the user.
activationParamExpiryMillisec	string	Refers to the expiry time (in millisecond) of the user's activation parameter.	86400000
resetParamExpiryMillisec	long	Refers to the expiry time (in millisecond) of the user's reset parameter.	86400000
inviteUserFlag	boolean	Indicates whether an invite email or a welcome email needs to be sent or not.	true

USER_RESET_CREDENTIAL

Property	Type	Description	Example
collectionId	long	Indicates the unique ID of the collection.	1
users.id	long	Indicates the ID of the user.	211
users.email	string	Indicates the unique email address of the user.	user@skava.com
users.phoneNumber	string	Holds the unique phone number of the user.	1675212054
users.firstName	string	Indicates the first name of the user.	Mannix
users.lastName	string	Indicates the last name of the user.	Bruce
users.status	string	Indicates the status of the user.	ACTIVE
users.type	string	Indicates the user type, such as a guest user or a registered user.	1
users.gender	string	Indicates the gender of the user.	male
users.photo	string	Holds the uploaded image URL of the user's profile photo.	Sample 3
users.dateOfBirth	string	Indicates the user's date of birth.	10/12/2000
users.resetParam	string	Indicates the reset parameter, which is received through the email or SMS.
users.activationParam	string	Indicates the activation param, which is used to activate the user.
users.preferences	string	Indicates the user's preferences, which are either email or phone number.	sms
users.createdDate	Date	Indicates the created timestamp of the user.	1543406415000
users.updatedDate	Date	Indicates the updated timestamp of the user.	1543406415000
users.addressess	list	Refers to the list of user's address.
users.userConsents	list	Refers to the list of user consent details.
resetPasswordRedirectUrl	string	Indicates the redirect URL of the site, which is used to reset the user password.
activationRedirectUrl	string	Indicates the redirect URL of the site, which is used to activate the user.
activationParamExpiryMillisec	string	Refers to the expiry time (in millisecond) of the user's activation parameter.	86400000
resetParamExpiryMillisec	long	Refers to the expiry time (in millisecond) of the user's reset parameter.	86400000
inviteUserFlag	boolean	Indicates whether an invite email or a welcome email needs to be sent or not.	true

ACCOUNTS_WELCOMEUSER

Property	Type	Description	Example
collectionId	long	Indicates the unique ID of the collection.	1
users.id	long	Indicates the ID of the user.	211
users.email	string	Indicates the unique email address of the user.	user@skava.com
users.phoneNumber	string	Holds the unique phone number of the user.	1675212054
users.firstName	string	Indicates the first name of the user.	Mannix
users.lastName	string	Indicates the last name of the user.	Bruce
users.status	string	Indicates the status of the user.	ACTIVE
users.type	string	Indicates the user type, such as a guest user or a registered user.	1
users.gender	string	Indicates the gender of the user.	male
users.photo	string	Holds the uploaded image URL of the user's profile photo.	Sample 3
users.dateOfBirth	string	Indicates the user's date of birth.	10/12/2000
users.resetParam	string	Indicates the reset parameter, which is received through the email or SMS.
users.activationParam	string	Indicates the activation param, which is used to activate the user.
users.preferences	string	Indicates the user's preferences, which are either email or phone number.	sms
users.createdDate	Date	Indicates the created timestamp of the user.	1543406415000
users.updatedDate	Date	Indicates the updated timestamp of the user.	1543406415000
users.addressess	list	Refers to the list of user's address.
users.userConsents	list	Refers to the list of user consent details.
resetPasswordRedirectUrl	string	Indicates the redirect URL of the site, which is used to reset the user password.
activationRedirectUrl	string	Indicates the redirect URL of the site, which is used to activate the user.
activationParamExpiryMillisec	string	Refers to the expiry time (in millisecond) of the user's activation parameter.	86400000
resetParamExpiryMillisec	long	Refers to the expiry time (in millisecond) of the user's reset parameter.	86400000
inviteUserFlag	boolean	Indicates whether an invite email or a welcome email needs to be sent or not.	true

ACCOUNTS_INVITEUSER

Property	Type	Description	Example
collectionId	long	Indicates the unique ID of the collection.	1
users.id	long	Indicates the ID of the user.	211
users.email	string	Indicates the unique email address of the user.	user@skava.com
users.phoneNumber	string	Holds the unique phone number of the user.	1675212054
users.firstName	string	Indicates the first name of the user.	Mannix
users.lastName	string	Indicates the last name of the user.	Bruce
users.status	string	Indicates the status of the user.	ACTIVE
users.type	string	Indicates the user type, such as a guest user or a registered user.	1
users.gender	string	Indicates the gender of the user.	male
users.photo	string	Holds the uploaded image URL of the user's profile photo.	Sample 3
users.dateOfBirth	string	Indicates the user's date of birth.	10/12/2000
users.resetParam	string	Indicates the reset parameter, which is received through the email or SMS.
users.activationParam	string	Indicates the activation param, which is used to activate the user.
users.preferences	string	Indicates the user's preferences, which are either email or phone number.	sms
users.createdDate	Date	Indicates the created timestamp of the user.	1543406415000
users.updatedDate	Date	Indicates the updated timestamp of the user.	1543406415000
users.addressess	list	Refers to the list of user's address.
users.userConsents	list	Refers to the list of user consent details.
resetPasswordRedirectUrl	string	Indicates the redirect URL of the site, which is used to reset the user password.
activationRedirectUrl	string	Indicates the redirect URL of the site, which is used to activate the user.
activationParamExpiryMillisec	string	Refers to the expiry time (in millisecond) of the user's activation parameter.	86400000
resetParamExpiryMillisec	long	Refers to the expiry time (in millisecond) of the user's reset parameter.	86400000
inviteUserFlag	boolean	Indicates whether an invite email or a welcome email needs to be sent or not.	true

LIST_SHARE

Property	Type	Description	Example
listRedirectUrl	string	Holds the list redirect URL.	http://www.tgiant.com/
list.listItems	string	Contains the list of items, which are available for the list.
list.listItems[].listItemId	string	Indicates the identifier of the listitem, which is created, updated, or deleted.	5c611a4075a285000a817d46
list.listItems[].key	string	Refers to the item key.	110001120
list.listItems[].name	string	Refers to the value of the key.	Green Shoe
list.listItems[].properties	string	Contains all the additional properties, which need to be added to a list item apart from the available default properties.
list.listId	string	Indicates the unique identifier of the list.	5c611a4075a285000a817d45
list.name	string	Refers to the name of the list. The name of the list is unique for a user within a collection.	My Fav
list.type	string	Refers to the type of the list.	WISHLIST
list.userId	string	Refers to the ID of the user who has created the list.	2316
list.itemType	string	Refers to the item type, which will be stored in the list.	SKU
list.accessType	string	Indicates the access type of the list. The possible values are: PUBLIC - the list can be accessed by any user. PRIVATE - the list is accessible by the user who owns the list.	PUBLIC
list.properties	string	Contains all the additional properties, which need to be added to a list apart from the available default properties.

ORDER_CONFIRMATION

Property	Type	Description	Example
user.firstName	string	Contains the first name of the user.	Srinivasan
user.lastName	string	Contains the last name of the user.
user.email	string	Indicates the email ID of the user.	user@skava.com
order.orderid	string	Contains the unique identifier of an order. This field is generated automatically.	16755331910lhe11
order.address_Street1	string	Indicates the first street name of the user address.	5thstreet
order.address_Street2	string	Indicates the second street name of the user address, if any.
order.city	string	Indicates the city of the user address.	NY
order.state	string	Indicates the state of the user address.
order.zipcode	string	Indicates the zip code of the user address.	AZ09OP
totalCostAfterDiscount	string	Contains the total discounted cost of an order or item.	792
order.orderDate	string	Indicates the created date of the order.	27 Nov, 2018 6:14:31 PM

LOYALTY_TRANSACTION

Property	Type	Description	Example
channel	string	Indicates the channel of the transaction.	mobile
collection_id	integer	Indicates the ID of the collection.	125
eventId	string	Indicates the unique identifier of the event associated with the transaction.	34
expiryTime	integer	Indicates the expiry time of the transaction in milliseconds.	2082652200000
identifier	string	Refers to the identifier of the item. The minimum length of the identifier is 1 and the maximum length of the identifier is 50.	transaction001
industryTransactionCode	string	Holds the industry transaction code of the transaction. This is an optional field.	1
industryTransactionId	string	Holds the industry transaction ID of the transaction. This is an optional field.	1
industryTransactionReference	string	Holds the industry transaction reference of the transaction. This is an optional field.	1
merchantCity	string	Holds the merchant city of the transaction. This is an optional field.	Texas
merchantClientID	string	Holds the merchant client ID of the transaction. This is an optional field.	690
merchantId	string	Holds the merchant ID of the transaction. This is an optional field.	50
merchantName	string	Holds the merchant name of the transaction. This is an optional field.	A-Star
merchantState	string	Holds the merchant state of the transaction. This is an optional field.	Texas
merchantZipcode	string	Holds the merchant zipcode of the transaction. This is an optional field.	78666
notes	string	Holds the notes of the transaction.	Transaction for order appeasement.
orderId	string	Holds the order ID of the transaction.	569
parentTransactionId	string	Indicates the unique identifier of the parent transaction. The old transaction ID is used when the current transaction needs to be associated with the old transaction.	77
properties	string	Indicates a list of properties of the transaction. It is key-value pair.
redemptionKey	string	Holds the redemption key of the transaction. This is an optional field.	1
redemptionMethod	string	Holds the redemption method of the transaction. This is an optional field.	orders
redemptionType	string	Holds the redemption type of the transaction. This is an optional field.	order
redemptionValue	string	Holds the redemption value of the transaction. This is an optional field.	10
redemptionVendor	string	Holds the redemption vendor of the transaction. This is an optional field.	A-Star
redemptionVendorId	string	Holds the redemption vendor ID of the transaction. This is an optional field.	40
rewardType	string	Indicates the reward type of the transaction.	POINTS
rewardValue	number	Indicates the reward value of the transaction.	50
storeId	string	Holds the unique identifier of the associated store.	99
type	string	Indicates the type of transaction. The following transaction types are applied: EARNED - to allocate the rewards to the customer. APPROVED - to approve the earned rewards. EXPIRED - to expire the earned and approved rewards. FORFEITED - to forfeit the approved rewards. CANCELED - to cancel the earned rewards. REDEEMED - to redeem the approved rewards. REVERSE_REDEEMED - to reverse the redeemed rewards. CYCLED - to prepare a report containing rewards of all transactions for the customer.	EARNED
userId	string	Indicates the unique valid identifier of the current user.	user001
userInfo	string	Indicates the unique identifier of the user who performs the action. This is an optional field when the user is logged in with an auth token. It is required only for super admin and common admin.	user001

 

 

Revision History
2020-01-14 | Ananthi – Updated content for February 2020 release.
2019-07-11 | Mary – Page created and content uploaded.