EVENT GUIDE
ebaycclone-watchlistcart-service
Handles user watchlists (with custom folders) and shopping cart preparation for checkout, strictly enforcing only fixed-price products in carts, supporting item moves/bulk operations, and robust default/folder logic..
Architectural Design Credit and Contact Information
The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:
Email:
We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.
Documentation Scope
Welcome to the official documentation for the
WatchlistCart
Service Event descriptions. This guide is dedicated to detailing
how to subscribe to and listen for state changes within the
WatchlistCart
Service, offering an exclusive focus on event subscription
mechanisms.
Intended Audience
This documentation is aimed at developers and integrators looking
to monitor
WatchlistCart
Service state changes. It is especially relevant for those wishing
to implement or enhance business logic based on interactions with
WatchlistCart
objects.
Overview
This section provides detailed instructions on monitoring service events, covering payload structures and demonstrating typical use cases through examples.
Authentication and Authorization
Access to the
WatchlistCart
service's events is facilitated through the project's Kafka
server, which is not accessible to the public. Subscription to a
Kafka topic requires being on the same network and possessing
valid Kafka user credentials. This document presupposes that
readers have existing access to the Kafka server.
Additionally, the service offers a public subscription option via REST for real-time data management in frontend applications, secured through REST API authentication and authorization mechanisms. To subscribe to service events via the REST API, please consult the Realtime REST API Guide.
Database Events
Database events are triggered at the database layer, automatically and atomically, in response to any modifications at the data level. These events serve to notify subscribers about the creation, update, or deletion of objects within the database, distinct from any overarching business logic.
Listening to database events is particularly beneficial for those focused on tracking changes at the database level. A typical use case for subscribing to database events is to replicate the data store of one service within another service's scope, ensuring data consistency and syncronization across services.
For example, while a business operation such as "approve
membership" might generate a high-level business event like
membership-approved, the underlying database changes could involve multiple state
updates to different entities. These might be published as
separate events, such as
dbevent-member-updated
and
dbevent-user-updated, reflecting the granular changes at the database level.
Such detailed eventing provides a robust foundation for building responsive, data-driven applications, enabling fine-grained observability and reaction to the dynamics of the data landscape. It also facilitates the architectural pattern of event sourcing, where state changes are captured as a sequence of events, allowing for high-fidelity data replication and history replay for analytical or auditing purposes.
DbEvent watchlistItem-created
Event topic:
ebaycclone-watchlistcart-service-dbevent-watchlistitem-created
This event is triggered upon the creation of a
watchlistItem
data object in the database. The event payload encompasses the
newly created data, encapsulated within the root of the paylod.
Event payload:
{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
DbEvent watchlistItem-updated
Event topic:
ebaycclone-watchlistcart-service-dbevent-watchlistitem-updated
Activation of this event follows the update of a
watchlistItem
data object. The payload contains the updated information under
the
watchlistItem
attribute, along with the original data prior to update, labeled
as
old_watchlistItem
and also you can find the old and new versions of updated-only
portion of the data..
Event payload:
{
old_watchlistItem:{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
watchlistItem:{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}
DbEvent watchlistItem-deleted
Event topic:
ebaycclone-watchlistcart-service-dbevent-watchlistitem-deleted
This event announces the deletion of a
watchlistItem
data object, covering both hard deletions (permanent removal) and
soft deletions (where the
isActive
attribute is set to false). Regardless of the deletion type, the
event payload will present the data as it was immediately before
deletion, highlighting an
isActive
status of false for soft deletions.
Event payload:
{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
DbEvent cartItem-created
Event topic:
ebaycclone-watchlistcart-service-dbevent-cartitem-created
This event is triggered upon the creation of a
cartItem
data object in the database. The event payload encompasses the
newly created data, encapsulated within the root of the paylod.
Event payload:
{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
DbEvent cartItem-updated
Event topic:
ebaycclone-watchlistcart-service-dbevent-cartitem-updated
Activation of this event follows the update of a
cartItem
data object. The payload contains the updated information under
the
cartItem
attribute, along with the original data prior to update, labeled
as
old_cartItem
and also you can find the old and new versions of updated-only
portion of the data..
Event payload:
{
old_cartItem:{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
cartItem:{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}
DbEvent cartItem-deleted
Event topic:
ebaycclone-watchlistcart-service-dbevent-cartitem-deleted
This event announces the deletion of a
cartItem
data object, covering both hard deletions (permanent removal) and
soft deletions (where the
isActive
attribute is set to false). Regardless of the deletion type, the
event payload will present the data as it was immediately before
deletion, highlighting an
isActive
status of false for soft deletions.
Event payload:
{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
DbEvent watchlistList-created
Event topic:
ebaycclone-watchlistcart-service-dbevent-watchlistlist-created
This event is triggered upon the creation of a
watchlistList
data object in the database. The event payload encompasses the
newly created data, encapsulated within the root of the paylod.
Event payload:
{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
DbEvent watchlistList-updated
Event topic:
ebaycclone-watchlistcart-service-dbevent-watchlistlist-updated
Activation of this event follows the update of a
watchlistList
data object. The payload contains the updated information under
the
watchlistList
attribute, along with the original data prior to update, labeled
as
old_watchlistList
and also you can find the old and new versions of updated-only
portion of the data..
Event payload:
{
old_watchlistList:{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
watchlistList:{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}
DbEvent watchlistList-deleted
Event topic:
ebaycclone-watchlistcart-service-dbevent-watchlistlist-deleted
This event announces the deletion of a
watchlistList
data object, covering both hard deletions (permanent removal) and
soft deletions (where the
isActive
attribute is set to false). Regardless of the deletion type, the
event payload will present the data as it was immediately before
deletion, highlighting an
isActive
status of false for soft deletions.
Event payload:
{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
ElasticSearch Index Events
Within the
WatchlistCart
service, most data objects are mirrored in ElasticSearch indices,
ensuring these indices remain syncronized with their database
counterparts through creation, updates, and deletions. These
indices serve dual purposes: they act as a data source for
external services and furnish aggregated data tailored to enhance
frontend user experiences. Consequently, an ElasticSearch index
might encapsulate data in its original form or aggregate
additional information from other data objects.
These aggregations can include both one-to-one and one-to-many relationships not only with database objects within the same service but also across different services. This capability allows developers to access comprehensive, aggregated data efficiently. By subscribing to ElasticSearch index events, developers are notified when an index is updated and can directly obtain the aggregated entity within the event payload, bypassing the need for separate ElasticSearch queries.
It's noteworthy that some services may augment another service's
index by appending to the entity’s
extends
object. In such scenarios, an
*-extended
event will contain only the newly added data. Should you require
the complete dataset, you would need to retrieve the full
ElasticSearch index entity using the provided ID.
This approach to indexing and event handling facilitates a modular, interconnected architecture where services can seamlessly integrate and react to changes, enriching the overall data ecosystem and enabling more dynamic, responsive applications.
Index Event watchlistitem-created
Event topic:
elastic-index-ebaycclone_watchlistitem-created
Event payload:
{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event watchlistitem-updated
Event topic:
elastic-index-ebaycclone_watchlistitem-created
Event payload:
{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event watchlistitem-deleted
Event topic:
elastic-index-ebaycclone_watchlistitem-deleted
Event payload:
{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event watchlistitem-extended
Event topic:
elastic-index-ebaycclone_watchlistitem-extended
Event payload:
{
id: id,
extends: {
[extendName]: "Object",
[extendName + "_count"]: "Number",
},
}
Route Events
Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route's execution, is more pertinent.
Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity's data but also route-specific metrics, such as the executing user's permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.
The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service's functional outcomes.
Route Event watchlistlist-listed
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistLists
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistLists
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistLists","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistLists":[{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitems-listed
Event topic :
ebaycclone-watchlistcart-service-cartitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","cartItems":[{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","product":[{"currency":"String","description":"Text","condition":"Enum","condition_idx":"Integer","price":"Double","title":"String","type":"Enum","type_idx":"Integer","mediaAssetIds":"ID"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitem-deleted
Event topic :
ebaycclone-watchlistcart-service-cartitem-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitem-created
Event topic :
ebaycclone-watchlistcart-service-watchlistitem-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"watchlistItem":{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitems-listed
Event topic :
ebaycclone-watchlistcart-service-watchlistitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistItems":[{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitemquantity-updated
Event topic :
ebaycclone-watchlistcart-service-cartitemquantity-updated
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistlist-created
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistList
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistList
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistList","method":"POST","action":"create","appVersion":"Version","rowCount":1,"watchlistList":{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistlist-deleted
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistList
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistList
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistList","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"watchlistList":{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitem-deleted
Event topic :
ebaycclone-watchlistcart-service-watchlistitem-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItem","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"watchlistItem":{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event cartitem-created
Event topic :
ebaycclone-watchlistcart-service-cartitem-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event userwatchlist-done
Event topic :
ebaycclone-watchlistcart-service-userwatchlist-done
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistItems":[{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event usercartitems-listed
Event topic :
ebaycclone-watchlistcart-service-usercartitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","cartItems":[{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","product":[{"currency":"String","description":"Text","condition":"Enum","condition_idx":"Integer","endPrice":"Double","price":"Double","title":"String","startPrice":"Double","type":"Enum","type_idx":"Integer","shipping":"Double"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event userwatchlistlists-done
Event topic :
ebaycclone-watchlistcart-service-userwatchlistlists-done
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistLists
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistLists
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistLists","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistLists":[{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Index Event cartitem-created
Event topic:
elastic-index-ebaycclone_cartitem-created
Event payload:
{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event cartitem-updated
Event topic:
elastic-index-ebaycclone_cartitem-created
Event payload:
{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event cartitem-deleted
Event topic:
elastic-index-ebaycclone_cartitem-deleted
Event payload:
{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event cartitem-extended
Event topic:
elastic-index-ebaycclone_cartitem-extended
Event payload:
{
id: id,
extends: {
[extendName]: "Object",
[extendName + "_count"]: "Number",
},
}
Route Events
Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route's execution, is more pertinent.
Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity's data but also route-specific metrics, such as the executing user's permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.
The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service's functional outcomes.
Route Event watchlistlist-listed
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistLists
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistLists
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistLists","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistLists":[{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitems-listed
Event topic :
ebaycclone-watchlistcart-service-cartitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","cartItems":[{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","product":[{"currency":"String","description":"Text","condition":"Enum","condition_idx":"Integer","price":"Double","title":"String","type":"Enum","type_idx":"Integer","mediaAssetIds":"ID"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitem-deleted
Event topic :
ebaycclone-watchlistcart-service-cartitem-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitem-created
Event topic :
ebaycclone-watchlistcart-service-watchlistitem-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"watchlistItem":{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitems-listed
Event topic :
ebaycclone-watchlistcart-service-watchlistitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistItems":[{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitemquantity-updated
Event topic :
ebaycclone-watchlistcart-service-cartitemquantity-updated
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistlist-created
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistList
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistList
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistList","method":"POST","action":"create","appVersion":"Version","rowCount":1,"watchlistList":{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistlist-deleted
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistList
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistList
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistList","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"watchlistList":{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitem-deleted
Event topic :
ebaycclone-watchlistcart-service-watchlistitem-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItem","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"watchlistItem":{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event cartitem-created
Event topic :
ebaycclone-watchlistcart-service-cartitem-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event userwatchlist-done
Event topic :
ebaycclone-watchlistcart-service-userwatchlist-done
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistItems":[{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event usercartitems-listed
Event topic :
ebaycclone-watchlistcart-service-usercartitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","cartItems":[{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","product":[{"currency":"String","description":"Text","condition":"Enum","condition_idx":"Integer","endPrice":"Double","price":"Double","title":"String","startPrice":"Double","type":"Enum","type_idx":"Integer","shipping":"Double"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event userwatchlistlists-done
Event topic :
ebaycclone-watchlistcart-service-userwatchlistlists-done
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistLists
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistLists
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistLists","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistLists":[{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Index Event watchlistlist-created
Event topic:
elastic-index-ebaycclone_watchlistlist-created
Event payload:
{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event watchlistlist-updated
Event topic:
elastic-index-ebaycclone_watchlistlist-created
Event payload:
{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event watchlistlist-deleted
Event topic:
elastic-index-ebaycclone_watchlistlist-deleted
Event payload:
{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}
Index Event watchlistlist-extended
Event topic:
elastic-index-ebaycclone_watchlistlist-extended
Event payload:
{
id: id,
extends: {
[extendName]: "Object",
[extendName + "_count"]: "Number",
},
}
Route Events
Route events are emitted following the successful execution of a route. While most routes perform CRUD (Create, Read, Update, Delete) operations on data objects, resulting in route events that closely resemble database events, there are distinctions worth noting. A single route execution might trigger multiple CRUD actions and ElasticSearch indexing operations. However, for those primarily concerned with the overarching business logic and its outcomes, listening to the consolidated route event, published once at the conclusion of the route's execution, is more pertinent.
Moreover, routes often deliver aggregated data beyond the primary database object, catering to specific client needs. For instance, creating a data object via a route might not only return the entity's data but also route-specific metrics, such as the executing user's permissions related to the entity. Alternatively, a route might automatically generate default child entities following the creation of a parent object. Consequently, the route event encapsulates a unified dataset encompassing both the parent and its children, in contrast to individual events triggered for each entity created. Therefore, subscribing to route events can offer a richer, more contextually relevant set of information aligned with business logic.
The payload of a route event mirrors the REST response JSON of the route, providing a direct and comprehensive reflection of the data and metadata communicated to the client. This ensures that subscribers to route events receive a payload that encapsulates both the primary data involved and any additional information deemed significant at the business level, facilitating a deeper understanding and integration of the service's functional outcomes.
Route Event watchlistlist-listed
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistLists
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistLists
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistLists","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistLists":[{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitems-listed
Event topic :
ebaycclone-watchlistcart-service-cartitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","cartItems":[{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","product":[{"currency":"String","description":"Text","condition":"Enum","condition_idx":"Integer","price":"Double","title":"String","type":"Enum","type_idx":"Integer","mediaAssetIds":"ID"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitem-deleted
Event topic :
ebaycclone-watchlistcart-service-cartitem-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitem-created
Event topic :
ebaycclone-watchlistcart-service-watchlistitem-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"watchlistItem":{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitems-listed
Event topic :
ebaycclone-watchlistcart-service-watchlistitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistItems":[{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event cartitemquantity-updated
Event topic :
ebaycclone-watchlistcart-service-cartitemquantity-updated
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistlist-created
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistList
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistList
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistList","method":"POST","action":"create","appVersion":"Version","rowCount":1,"watchlistList":{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistlist-deleted
Event topic :
ebaycclone-watchlistcart-service-watchlistlist-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistList
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistList
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistList","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"watchlistList":{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event watchlistitem-deleted
Event topic :
ebaycclone-watchlistcart-service-watchlistitem-deleted
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItem","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"watchlistItem":{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event cartitem-created
Event topic :
ebaycclone-watchlistcart-service-cartitem-created
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItem
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItem
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"201","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"cartItem":{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}
Route Event userwatchlist-done
Event topic :
ebaycclone-watchlistcart-service-userwatchlist-done
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistItems":[{"id":"ID","userId":"ID","addedAt":"Date","productId":"ID","listId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event usercartitems-listed
Event topic :
ebaycclone-watchlistcart-service-usercartitems-listed
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
cartItems
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
cartItems
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"cartItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","cartItems":[{"id":"ID","addedAt":"Date","userId":"ID","quantity":"Integer","productId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID","product":[{"currency":"String","description":"Text","condition":"Enum","condition_idx":"Integer","endPrice":"Double","price":"Double","title":"String","startPrice":"Double","type":"Enum","type_idx":"Integer","shipping":"Double"},{},{}]},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Route Event userwatchlistlists-done
Event topic :
ebaycclone-watchlistcart-service-userwatchlistlists-done
Event payload:
The event payload, mirroring the REST API response, is structured
as an encapsulated JSON. It includes metadata related to the API
as well as the
watchlistLists
data object itself.
The following JSON included in the payload illustrates the fullest
representation of the
watchlistLists
object. Note, however, that certain properties might be excluded
in accordance with the object's inherent logic.
{"status":"OK","statusCode":"200","elapsedMs":126,"ssoTime":120,"source":"db","cacheKey":"hexCode","userId":"ID","sessionId":"ID","requestId":"ID","dataName":"watchlistLists","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","watchlistLists":[{"id":"ID","name":"String","itemCount":"Integer","userId":"ID","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}
Copyright
All sources, documents and other digital materials are copyright of .
About Us
For more information please visit our website: .
. .