This page provides the list of events and associated payloads for the Feeds microservice.
Page Contents
List of Events
SL.# | Name | Description | Publish Location | Routing Key | Durability | Payload Type |
---|---|---|---|---|---|---|
1 | Feed Start Event | This event is triggered when the feed is started. | Topic: ecomm | feed.schedule.start.catalog.catalogimport.*.# | false | FeedStartEvent |
2 | Feed End Event | This event is triggered when the feed is ended. | Topic: ecomm | feed.schedule.end.catalog.catalogimport.*.# | false | FeedEndEvent |
Payload Models
Below are the payloads for the Feeds microservice events.
FeedStartEvent
Property | Type | Description | Example |
---|---|---|---|
collectionId | Long | Indicates the ID of the collection. | 1 |
scheduleId | String | Indicates the ID of the feed schedule. | schedule_catalog_import |
feedId | String | Indicates the ID of the feed. | catalogimport |
jobId | String | Indicates the ID of the feed job. | 1_catalogimport |
serviceType | String | Specifies the type of service, such as catalog, pricing, inventory, etc. | catalog |
params | JSONArray | Holds the parameters of the feed schedule. | [{"name":"collectionId","stringValue":"1"},{"name":"catalogId","stringValue":"master"}] |
status | enum | Indicates the status of the feed, such as COMPLETE, ERROR, RUNNING, and UNKNOWN. | RUNNING |
summary | JSONObject | Indicates the summary report of the feed, which contains create, update, and failed count and reason. | null |
FeedEndEvent
Property | Type | Description | Example |
---|---|---|---|
collectionId | Long | Indicates the ID of the collection. | 1 |
scheduleId | String | Indicates the ID of the feed schedule. | schedule_catalog_import |
feedId | String | Indicates the ID of the feed. | catalogimport |
jobId | String | Indicates the ID of the feed job. | 1_catalogimport |
serviceType | String | Specifies the type of service, such as catalog, pricing, inventory, etc. | catalog |
params | JSONArray | Holds the parameters of the feed schedule. | [{"name":"collectionId","stringValue":"1"},{"name":"catalogId","stringValue":"master"}] |
status | enum | Indicates the status of the feed, such as COMPLETE, ERROR, RUNNING, and UNKNOWN. | COMPLETE |
summary | JSONObject | Indicates the summary report of the feed, which contains create, update, and failed count and reason. | {\"attribute\":{\"created\":200,\"updated\":7,\"failed\":1,\"failed_reason\":[{\"identifier\":\"producttype\",\"reason\":\"Custom attribute cannot be updated : producttype\",\"Rows\":{\"0\":\"producttype\",\"1\":\"Static\",\"2\":\"False\",\"3\":\"Enummultiselect\",\"4\":\"False\",\"5\":\"False\",\"6\":\"False\",\"7\":\"Active\",\"8\":\"2018-06-15T13:45:30\",\"9\":\"2025-06-15T13:45:30\",\"10\":\"ProductType\",\"11\":\"collection,bundle\"}}]},\"product\":{\"created\":125,\"updated\":1,\"failed\":0,\"failed_reason\":[]},\"sku\":{\"created\":8,\"updated\":5,\"failed\":0,\"failed_reason\":[]}} |
Revision History
2019-06-08 | PLK – Minor copyedits.
2019-05-10 | Ananthi – Minor copyedits.
2019-04-08 | Ananthi – Content updated for April 2019 release.
2019-01-21 | PLK – Page added.