EVENT GUIDE

ebaycclone-ordermanagement-service

Handles all marketplace orders, manual checkout flows for fixed-price/offer/auction settlements, Stripe payment processing and webhook reconciliation, explicit status updates (shipping, delivery, cancellation), and feedback eligibility via orderItems.

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 OrderManagement Service Event descriptions. This guide is dedicated to detailing how to subscribe to and listen for state changes within the OrderManagement Service, offering an exclusive focus on event subscription mechanisms.

Intended Audience

This documentation is aimed at developers and integrators looking to monitor OrderManagement Service state changes. It is especially relevant for those wishing to implement or enhance business logic based on interactions with OrderManagement 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 OrderManagement 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 orderManagementOrder-created

Event topic: ebaycclone-ordermanagement-service-dbevent-ordermanagementorder-created

This event is triggered upon the creation of a orderManagementOrder data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent orderManagementOrder-updated

Event topic: ebaycclone-ordermanagement-service-dbevent-ordermanagementorder-updated

Activation of this event follows the update of a orderManagementOrder data object. The payload contains the updated information under the orderManagementOrder attribute, along with the original data prior to update, labeled as old_orderManagementOrder and also you can find the old and new versions of updated-only portion of the data..

Event payload:

{
old_orderManagementOrder:{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
orderManagementOrder:{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent orderManagementOrder-deleted

Event topic: ebaycclone-ordermanagement-service-dbevent-ordermanagementorder-deleted

This event announces the deletion of a orderManagementOrder 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","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent orderManagementOrderItem-created

Event topic: ebaycclone-ordermanagement-service-dbevent-ordermanagementorderitem-created

This event is triggered upon the creation of a orderManagementOrderItem data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent orderManagementOrderItem-updated

Event topic: ebaycclone-ordermanagement-service-dbevent-ordermanagementorderitem-updated

Activation of this event follows the update of a orderManagementOrderItem data object. The payload contains the updated information under the orderManagementOrderItem attribute, along with the original data prior to update, labeled as old_orderManagementOrderItem and also you can find the old and new versions of updated-only portion of the data..

Event payload:

{
old_orderManagementOrderItem:{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
orderManagementOrderItem:{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent orderManagementOrderItem-deleted

Event topic: ebaycclone-ordermanagement-service-dbevent-ordermanagementorderitem-deleted

This event announces the deletion of a orderManagementOrderItem 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","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent sys_orderManagementOrderPayment-created

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_ordermanagementorderpayment-created

This event is triggered upon the creation of a sys_orderManagementOrderPayment data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent sys_orderManagementOrderPayment-updated

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_ordermanagementorderpayment-updated

Activation of this event follows the update of a sys_orderManagementOrderPayment data object. The payload contains the updated information under the sys_orderManagementOrderPayment attribute, along with the original data prior to update, labeled as old_sys_orderManagementOrderPayment and also you can find the old and new versions of updated-only portion of the data..

Event payload:

{
old_sys_orderManagementOrderPayment:{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
sys_orderManagementOrderPayment:{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent sys_orderManagementOrderPayment-deleted

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_ordermanagementorderpayment-deleted

This event announces the deletion of a sys_orderManagementOrderPayment 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","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent sys_paymentCustomer-created

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_paymentcustomer-created

This event is triggered upon the creation of a sys_paymentCustomer 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","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent sys_paymentCustomer-updated

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_paymentcustomer-updated

Activation of this event follows the update of a sys_paymentCustomer data object. The payload contains the updated information under the sys_paymentCustomer attribute, along with the original data prior to update, labeled as old_sys_paymentCustomer and also you can find the old and new versions of updated-only portion of the data..

Event payload:

{
old_sys_paymentCustomer:{"id":"ID","userId":"ID","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
sys_paymentCustomer:{"id":"ID","userId":"ID","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent sys_paymentCustomer-deleted

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_paymentcustomer-deleted

This event announces the deletion of a sys_paymentCustomer 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","customerId":"String","platform":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent sys_paymentMethod-created

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_paymentmethod-created

This event is triggered upon the creation of a sys_paymentMethod data object in the database. The event payload encompasses the newly created data, encapsulated within the root of the paylod.

Event payload:

{"id":"ID","paymentMethodId":"String","userId":"ID","customerId":"String","cardHolderName":"String","cardHolderZip":"String","platform":"String","cardInfo":"Object","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

DbEvent sys_paymentMethod-updated

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_paymentmethod-updated

Activation of this event follows the update of a sys_paymentMethod data object. The payload contains the updated information under the sys_paymentMethod attribute, along with the original data prior to update, labeled as old_sys_paymentMethod and also you can find the old and new versions of updated-only portion of the data..

Event payload:

{
old_sys_paymentMethod:{"id":"ID","paymentMethodId":"String","userId":"ID","customerId":"String","cardHolderName":"String","cardHolderZip":"String","platform":"String","cardInfo":"Object","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
sys_paymentMethod:{"id":"ID","paymentMethodId":"String","userId":"ID","customerId":"String","cardHolderName":"String","cardHolderZip":"String","platform":"String","cardInfo":"Object","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},
oldDataValues,
newDataValues
}

DbEvent sys_paymentMethod-deleted

Event topic: ebaycclone-ordermanagement-service-dbevent-sys_paymentmethod-deleted

This event announces the deletion of a sys_paymentMethod 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","paymentMethodId":"String","userId":"ID","customerId":"String","cardHolderName":"String","cardHolderZip":"String","platform":"String","cardInfo":"Object","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

ElasticSearch Index Events

Within the OrderManagement 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 ordermanagementorder-created

Event topic: elastic-index-ebaycclone_ordermanagementorder-created

Event payload:

{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event ordermanagementorder-updated

Event topic: elastic-index-ebaycclone_ordermanagementorder-created

Event payload:

{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event ordermanagementorder-deleted

Event topic: elastic-index-ebaycclone_ordermanagementorder-deleted

Event payload:

{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event ordermanagementorder-extended

Event topic: elastic-index-ebaycclone_ordermanagementorder-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 ordermanagementorders-listed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorders-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 orderManagementOrders data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrders 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":"orderManagementOrders","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","orderManagementOrders":[{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ordermanagementorderitem-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderitem-retrived

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 orderManagementOrderItem data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrderItem 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":"orderManagementOrderItem","method":"GET","action":"get","appVersion":"Version","rowCount":1,"orderManagementOrderItem":{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorder-deleted

Event topic : ebaycclone-ordermanagement-service-ordermanagementorder-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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorder-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorder-retrived

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"GET","action":"get","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderstatus-updated

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderstatus-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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event orderstripewebhook-completed

Event topic : ebaycclone-ordermanagement-service-orderstripewebhook-completed

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderbyproductid-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderbyproductid-retrived

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"GET","action":"get","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorder-created

Event topic : ebaycclone-ordermanagement-service-ordermanagementorder-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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"POST","action":"create","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderitems-listed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderitems-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 orderManagementOrderItems data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrderItems 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":"orderManagementOrderItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","orderManagementOrderItems":[{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ownordermanagementorders-listed

Event topic : ebaycclone-ordermanagement-service-ownordermanagementorders-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 orderManagementOrders data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrders 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":"orderManagementOrders","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","orderManagementOrders":[{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ordermanagementownorderitem-lissed

Event topic : ebaycclone-ordermanagement-service-ordermanagementownorderitem-lissed

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 orderManagementOrderItems data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrderItems 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":"orderManagementOrderItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","orderManagementOrderItems":[{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ordermanagementorderitem-created

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderitem-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 orderManagementOrderItem data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrderItem 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":"orderManagementOrderItem","method":"POST","action":"create","appVersion":"Version","rowCount":1,"orderManagementOrderItem":{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayment2-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment2-retrived

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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayments2-listed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayments2-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 sys_orderManagementOrderPayments data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayments 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":"sys_orderManagementOrderPayments","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_orderManagementOrderPayments":[{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ordermanagementorderpayment-created

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment-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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"POST","action":"create","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayment-updated

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment-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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayment-deleted

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment-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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayments2-listed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayments2-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 sys_orderManagementOrderPayments data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayments 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":"sys_orderManagementOrderPayments","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_orderManagementOrderPayments":[{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ordermanagementorderpaymentbyorderid-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpaymentbyorderid-retrived

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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpaymentbypaymentid-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpaymentbypaymentid-retrived

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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayment2-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment2-retrived

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 sys_orderManagementOrderPayment data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_orderManagementOrderPayment 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":"sys_orderManagementOrderPayment","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_orderManagementOrderPayment":{"id":"ID","ownerId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"String","statusLiteral":"String","redirectUrl":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderpayment-started

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment-started

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

Route Event ordermanagementorderpayment-refreshed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment-refreshed

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

Route Event ordermanagementorderpayment-calledback

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderpayment-calledback

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"POST","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},"paymentResult":{"paymentTicketId":"ID","orderId":"ID","paymentId":"String","paymentStatus":"Enum","paymentIntentInfo":"Object","statusLiteral":"String","amount":"Double","currency":"String","success":true,"description":"String","metadata":"Object","paymentUserParams":"Object"}}

Route Event paymentcustomerbyuserid-retrived

Event topic : ebaycclone-ordermanagement-service-paymentcustomerbyuserid-retrived

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 sys_paymentCustomer data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_paymentCustomer 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":"sys_paymentCustomer","method":"GET","action":"get","appVersion":"Version","rowCount":1,"sys_paymentCustomer":{"id":"ID","userId":"ID","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event paymentcustomers-listed

Event topic : ebaycclone-ordermanagement-service-paymentcustomers-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 sys_paymentCustomers data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_paymentCustomers 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":"sys_paymentCustomers","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_paymentCustomers":[{"id":"ID","userId":"ID","customerId":"String","platform":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event paymentcustomermethods-listed

Event topic : ebaycclone-ordermanagement-service-paymentcustomermethods-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 sys_paymentMethods data object itself.

The following JSON included in the payload illustrates the fullest representation of the sys_paymentMethods 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":"sys_paymentMethods","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","sys_paymentMethods":[{"id":"ID","paymentMethodId":"String","userId":"ID","customerId":"String","cardHolderName":"String","cardHolderZip":"String","platform":"String","cardInfo":"Object","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Index Event ordermanagementorderitem-created

Event topic: elastic-index-ebaycclone_ordermanagementorderitem-created

Event payload:

{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event ordermanagementorderitem-updated

Event topic: elastic-index-ebaycclone_ordermanagementorderitem-created

Event payload:

{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event ordermanagementorderitem-deleted

Event topic: elastic-index-ebaycclone_ordermanagementorderitem-deleted

Event payload:

{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}

Index Event ordermanagementorderitem-extended

Event topic: elastic-index-ebaycclone_ordermanagementorderitem-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 ordermanagementorders-listed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorders-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 orderManagementOrders data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrders 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":"orderManagementOrders","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","orderManagementOrders":[{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}

Route Event ordermanagementorderitem-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderitem-retrived

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 orderManagementOrderItem data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrderItem 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":"orderManagementOrderItem","method":"GET","action":"get","appVersion":"Version","rowCount":1,"orderManagementOrderItem":{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorder-deleted

Event topic : ebaycclone-ordermanagement-service-ordermanagementorder-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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"DELETE","action":"delete","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":false,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorder-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorder-retrived

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"GET","action":"get","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderstatus-updated

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderstatus-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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event orderstripewebhook-completed

Event topic : ebaycclone-ordermanagement-service-orderstripewebhook-completed

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"PATCH","action":"update","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderbyproductid-retrived

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderbyproductid-retrived

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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"GET","action":"get","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorder-created

Event topic : ebaycclone-ordermanagement-service-ordermanagementorder-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 orderManagementOrder data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrder 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":"orderManagementOrder","method":"POST","action":"create","appVersion":"Version","rowCount":1,"orderManagementOrder":{"id":"ID","orderNumber":"String","items":"ID","buyerId":"ID","status":"Enum","status_idx":"Integer","paymentMethodId":"String","stripeCustomerId":"String","paymentIntentId":"String","shippingAddress":"Object","summary":"Object","trackingNumber":"String","estimatedDelivery":"Date","cancelledAt":"Date","paidAt":"Date","deliveredAt":"Date","shippedAt":"Date","carrier":"String","_paymentConfirmation":"Enum","_paymentConfirmation_idx":"Integer","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"}}

Route Event ordermanagementorderitems-listed

Event topic : ebaycclone-ordermanagement-service-ordermanagementorderitems-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 orderManagementOrderItems data object itself.

The following JSON included in the payload illustrates the fullest representation of the orderManagementOrderItems 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":"orderManagementOrderItems","method":"GET","action":"list","appVersion":"Version","rowCount":"\"Number\"","orderManagementOrderItems":[{"id":"ID","shipping":"Double","orderId":"ID","quantity":"Integer","productId":"ID","price":"Double","sellerId":"ID","title":"String","currency":"String","isActive":true,"recordVersion":"Integer","createdAt":"Date","updatedAt":"Date","_owner":"ID"},{},{}],"paging":{"pageNumber":"Number","pageRowCount":"NUmber","totalRowCount":"Number","pageCount":"Number"},"filters":[],"uiPermissions":[]}