This page provides the list of events and associated payload for internal events (via RabbitMQ/AWS MQ) and external events (via EventBridge) for the Foundation microservice.
External Events via EventBridge
The following events contain the entity changed in the event message payload.
List of Events
Payload
| Event Type | Response Payload |
|---|---|
foundationservice/business/create | {"cdnUrl":"https://d16rliti0tklvn.cloudfront.net","createdBy":0,"createdOn":"","defaultCurrency":"USD","defaultLocale":"en_US","description":"XoYCoxAbDcNDCixBQTCaCQITtPoORIYjYKtfHfxSAjKNeAQKYF","id":0,"name":"businessname_1677473530958","properties":[],"services":[{"name":"cje","status":1},{"name":"cartcheckout","status":1},{"name":"inventory","status":1},{"name":"list","status":1},{"name":"loyalty","status":1},{"name":"marketing"},{"name":"order","status":1},{"name":"catalog","status":1},{"name":"pricing","status":1},{"name":"promotion","status":1},{"name":"customer","status":1},{"name":"subscription","status":1}],"status":1,"storageServiceUrl":"https://s3.amazonaws.com/skava.stage.store.atfingertips.com","updatedBy":0,"updatedOn":""} |
foundationservice/business/update | {"cdnUrl":"https://d16rliti0tklvn.cloudfront.net","createdBy":1,"defaultCurrency":"USD","defaultLocale":"en_US","id":1,"logoUrl":"https://www.skava.com/logo.png","name":"Skava","properties":[{"createdBy":1,"name":"prop.username1","updatedBy":1,"value":true}],"services":[{"name":"catalog","status":1}],"status":1,"storageServiceUrl":"https://s3.amazonaws.com/skava.stage.store.atfingertips.com","updatedBy":1} |
foundationservice/storeassociation/create | {"associations":[{"collectionId":"1677474376076","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"loyalty","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"},{"collectionId":"1677474376076","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"customer","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"}]} |
foundationservice/storeassociation/patch | {"associations":[{"collectionId":"100","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"loyalty","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"},{"collectionId":"100","jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"customer","properties":[{"name":"BinId","value":"Bin1"}],"type":"microservice"}]} |
foundationservice/storeassociation/update | no PATCH CALL present for store association in swagger |
foundationservice/storeassociation/delete | need only corresponding id's |
foundationservice/storeassociationproperties/create | {"properties":[{"name":"fHiqVJ","value":"Property_Value_5"}]} |
feedservice/feedjob/update | {"description":"string","executionType":"string","jobId":"string","jobParams":[{"name":"string","stringValue":"string"}],"maxRunTime":0,"name":"string","serviceType":"string","status":"ACTIVE"} |
foundationservice/storeassociationproperties/patch | no PATCH CALL present in swagger |
foundationservice/storeassociationproperties/update | {"properties":[{"name":"Property956557","value":"Property_Value_67"}]} |
foundationservice/storeassociationproperties/delete | need only corresponding id's |
foundationservice/businessproperty/create | [{"createdBy":1,"name":"prop.username12","updatedBy":1,"value":true}] |
foundationservice/businessproperty/patch | no PATCH CALL present in swagger |
foundationservice/businessproperty/update | [{"createdBy":1,"name":"prop.username","updatedBy":1,"value":false}] |
foundationservice/storeproperty/create | {"properties":[{"custom":false,"description":"GRjoNXHDrY","name":"Property157180319866","value":"propertyValue462"}]} |
foundationservice/storeproperty/update | {"properties":[{"custom":false,"description":"opzajkEzgF","name":"Property526905","value":"propertyValue960"}]} |
foundationservice/storeproperty/patch | no PATCH CALL present for store property in swagger |
foundationservice/storeproperty/delete | need only corresponding id's |
foundationservice/store/create | {"associations":[{"collectionId":1,"defaultAssociation":false,"id":0,"jurisdiction":[{"countryCode":"+1","documentId":1}],"name":"loyalty","properties":[{"name":"loyaltypoints","value":"yvyVpQYRd"}]}],"businessId":"1","currencies":["USD"],"defaultCurrency":"USD","defaultLocale":"en_US","defaultShippingRegion":"US","id":0,"launchUrl":"https://www.skava.com","locales":["en_US"],"logoUrl":"https://www.store.com/logo.png","name":"EeNci","previewUrl":"https://www.skava.com","properties":[{"description":"Maintenance date of every month","name":"prop_maintenancedate","value":25}],"shippings":["US"],"status":"1","timeZone":"UTC","type":"2"} |
foundationservice/store/update | {"associations":[{"collectionId":1,"defaultAssociation":false,"id":0,"jurisdiction":[{"countryCode":"US","documentId":1}],"name":"loyalty","properties":[{"name":"prop_maintenancedate","value":25}]},{"collectionId":2,"defaultAssociation":true,"id":0,"jurisdiction":[{"countryCode":"US","documentId":1}],"name":"subscription","properties":[]},{"collectionId":0,"defaultAssociation":true,"jurisdiction":[{"countryCode":"XincHK","documentId":"XincHK","supported":true}],"name":"XincHK","properties":[{"name":"XincHK","value":"XincHK"}],"storeId":0,"type":"XincHK"}],"businessId":"1","defaultCurrency":"USD","defaultLocale":"en_US","defaultShippingRegion":"US","launchUrl":"https://www.skava.com","name":"SpFyCsyS","previewUrl":"https://www.skava.com","properties":[{"canDelete":true,"description":"XincHK","name":"XincHK","storeId":0,"value":"XincHK"}],"status":"1","timeZone":"UTC","type":"2"} |
Internal Events via RabbitMQ/AWS MQ
The following events communicate with the internal microservices.
List of Events
| SL.# | Name | Description | Publish Location | Routing Keys | Durability | Payload Type |
|---|---|---|---|---|---|---|
| 1 | Create Business | This event is triggered when a business is created. | Topic: ecomm | foundation.business.create | false | FoundationBusiness |
| 2 | Update Business | This event is triggered when the business is updated. | Topic: ecomm | foundation.business.update | false | FoundationBusiness |
| 3 | Create Store | This event is triggered when a store is created. | Topic: ecomm | foundation.store.create | false | FoundationStore |
| 4 | Update Store | This event is triggered when the store is updated. | Topic: ecomm | foundation.store.update | false | FoundationStore |
| 5 | Create Business Properties | This event is triggered when the business properties are created. | Topic: ecomm | foundation.businessproperties.create | false | FoundationBusinessProperties |
| 6 | Update Business Properties | This event is triggered when the business properties are updated. | Topic: ecomm | foundation.businessproperties.update | false | FoundationBusinessProperties |
| 7 | Delete Business Property | This event is triggered when the business property is deleted. | Topic: ecomm | foundation.businessproperty.delete | false | FoundationBusinessProperties |
| 8 | Create Store Properties | This event is triggered when the store properties are created. | Topic: ecomm | foundation.storeproperties.create | false | FoundationStoreProperties |
| 9 | Update Store Properties | This event is triggered when the store properties are updated. | Topic: ecomm | foundation.storeproperties.update | false | FoundationStoreProperties |
| 10 | Create Store Associations | This event is triggered when the associations are created. | Topic: ecomm | foundation.assocations.create | false | FoundationStoreAssociation |
| 11 | Update Store Associations | This event is triggered when the associations are updated. | Topic: ecomm | foundation.assocations.update | false | FoundationStoreAssociation |
| 12 | Update Store Association | This event is triggered when the association is updated. | Topic: ecomm | foundation.assocation.update | false | FoundationStoreAssociation |
| 13 | Create Store Association Properties | This event is triggered when the association properties are created. | Topic: ecomm | foundation.assocationproperties.create | false | FoundationStoreAssociationProperties |
| 14 | Update Store Association Properties | This event is triggered when the associations properties are updated. | Topic: ecomm | foundation.assocationproperties.update | false | FoundationStoreAssociationProperties |
| 15 | Update Store Association Property | This event is triggered when the association property is updated. | Topic: ecomm | foundation.assocationproperty.update | false | FoundationStoreAssociationProperties |
| 16 | Delete Store Association Property | This event is triggered when the association property is deleted. | Topic: ecomm | foundation.assocationproperty.delete | false | FoundationStoreAssociationProperties |
| 17 | Update Business Status | This event is triggered when the business status is updated. | Topic: ecomm | foundation.business.statusupdate | false | FoundationBusiness |
Payload Models
Below are payloads for the Foundation microservice events.
FoundationBusiness
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
name | string | Indicates the business name. | AdminBusiness |
status | integer | Represents the status of the business. The possible values are 0 – indicates the inactive status and 1 – indicates the active status. | 1 |
storageServiceUrl | string | Represents the AWS (s3) bucket URL. | https://s3.amazonaws.com/skava.stage.store.atfingertips.com |
cdnUrl | string | Represents the AWS CloudFront CDN URL. | https://d16rliti0tklvn.cloudfront.net |
logoUrl | string | Indicates the URL of the business logo. | https://www.skava.com/logo.png |
defaultLocale | string | Represents the default locale of the business. | en_US |
defaultCurrency | string | Represents the default currency of the business. | USD |
services[].name | string | Indicates the service name, which is an identifier of service. | catalog |
services[].status | integer | Indicates the status of the service associated with the business. The possible values are: 0 – indicates the inactive status and 1 – indicates the active status. | 1 |
properties[].name | string | Contains the name of the business property for a particular business ID. | prop.username |
properties[].value | string | Contains the value of the business property for the given name and business ID. | true |
properties[].createdBy | string | Represents ID of the user, who has created this entry. | 1 |
properties[].updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
createdBy | string | Represents ID of the user, who has created this entry. | 1 |
updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
FoundationStore
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
allowPreview | boolean | Indicates whether the store is allowed to be previewed or not. | false |
associations[].collectionId | long | Indicates the ID of the collection of the service associated. | 1 |
associations[].defaultAssociation | boolean | Indicates whether the association is the default association or not. | false |
associations[].id | long | Indicates an auto-generated unique ID of the store and service association. | 0 |
associations[].jurisdiction[].countryCode | string | Indicates the country code of this store jurisdiction. | US |
associations[].jurisdiction[].documentId | string | Indicates the document ID, which corresponds to the price list of this store jurisdiction. | 1 |
associations[].name | string | Indicates the name of the service associated with the store. | loyalty |
associations[].properties[].collectionId | long | Indicates the collection ID of the service associated. | 1 |
associations[].properties[].name | string | Indicates the name of the property. | prop_maintenancedate |
associations[].properties[].value | string | Indicates the value of the store association property. | 25 |
associations[].createdBy | string | Represents ID of the user, who has created this entry. | 1 |
associations[].updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
businessId | long | Indicates the ID of the business to which this store belongs. | 1 |
currencies[] | List [string] | Indicates the list of currency for this store. | USD |
defaultCurrency | string | Indicates the default currency of the store. | USD |
defaultLocale | string | Indicates the default locale of the store. | en_US |
defaultShippingRegion | string | Indicates the default ship-to-region of the store. | US |
id | long | Indicates an auto-generated unique ID of the store. | 0 |
launchUrl | string | Indicates the URL with which the store can be launched. | https://www.store.com |
locales[] | List [string] | Indicates the list of locales of this store. | en_US |
logoUrl | string | Indicates the URL of the store logo. | https://www.store.com/logo.png |
name | string | Indicates the store name provided by the user. | StoreA |
previewUrl | string | Indicates the URL with which the store can be previewed for future dates. | https://www.storepreview.com |
properties[].description | string | Indicates the description of the store property. | Maintenance date of every month |
properties[].name | string | Indicates the name of the property. | prop_maintenancedate |
properties[].value | string | Indicates the value of the store association property. | 25 |
shippings[] | List [string] | Indicates the list of shipping countries of this store. | US |
status | integer | Indicates the status of the store. | 1 |
timeZone | string | Indicates the timezone of the store provided by the user. | UTC |
type | integer | Indicates the type of the store. It refers to the ID of the StoreType object. The value 1 indicates a B2B store. The value 2 indicates a B2C store. | 1 |
createdBy | string | Represents ID of the user, who has created this entry. | 1 |
updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
FoundationBusinessProperties
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
name | string | Contains the name of the business property for a particular business ID. | prop.username |
value | string | Contains the value of the business property for the given name and business ID. | true |
createdBy | string | Represents ID of the user, who has created this entry. | 1 |
updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
FoundationStoreProperties
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
description | string | Indicates the description of the store property. | Maintenance date of every month |
name | string | Indicates the name of the store property for the particular business ID. | prop_maintenancedate |
value | string | Indicates the value of a store property with respect to the name and store ID. | 25 |
createdBy | string | Represents ID of the user, who has created this entry. | 1 |
updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
FoundationStoreAssociation
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the ID of the collection of the service associated. | 1 |
defaultAssociation | boolean | Indicates whether the association is the default association or not. | false |
id | long | Indicates an auto-generated unique ID of the store. | 0 |
jurisdiction[].countryCode | string | Indicates the country code of this store jurisdiction. | US |
jurisdiction[].documentId | string | Indicates the document ID, which corresponds to the price list of this store jurisdiction. | 1 |
name | string | Indicates the name of the service associated with the store. | loyalty |
properties[].collectionId | long | Indicates the ID of the collection. | 1 |
properties[].name | string | Indicates the name of the property. | prop_maintenancedate |
properties[].value | string | Indicates the value of the store association property. | 25 |
createdBy | string | Represents ID of the user, who has created this entry. | 1 |
updatedBy | string | Represents ID of the user, who has updated this entry. | 1 |
FoundationStoreAssociationProperties
| PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|
collectionId | long | Indicates the ID of the collection. | 1 |
name | string | Indicates the name of the property. | prop_maintenancedate |
value | string | Indicates the value of the store association property. | 25 |
Revision History
2019-06-08 | PLK – Minor copyedits.
2019-05-16 | Ananthi – Updated to a new table tool.
2019-05-06 | PLK – Minor copyedits.
2019-04-11 | MA – Updated content for April 2019 release.
2019-01-22 | PLK – Page added.
