Services | Finance Service | AsyncApi Spec
Orchestrates order processing and financial transactions for BookWorm
Servers
- amqp://dev.eventbus:5672/amqp 0.9.1development
RabbitMQ server for development environment
Security:
- User/Password
An authentication method for the server
- #env:development
- amqp://stg.eventbus:5672/amqp 0.9.1staging
RabbitMQ server for staging environment
Security:
- User/Password
An authentication method for the server
- #env:staging
- amqp://qa.eventbus:5672/amqp 0.9.1qa
RabbitMQ server for QA environment
Security:
- User/Password
An authentication method for the server
- #env:qa
- amqp://prod.eventbus:5672/amqp 0.9.1production
RabbitMQ server for production environment
Security:
- User/Password
An authentication method for the server
- #env:production
Operations
SEND notification-cancel-order
Event emitted when a user cancels an order
Cancel order notification
Represents a successful integration event when cancelling an order in the system
Operation IDCancelOrderCommandAvailable only on servers:
Accepts the following message:
Message IDCancelOrderCommand.messageallOfEvent published when a user cancels an order, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "totalMoney": 100 }
This example has been generated automatically.
SEND notification-complete-order
Event emitted when a user completes an order
Complete order notification
Represents a successful integration event when completing an order in the system
Operation IDCompleteOrderCommandAvailable only on servers:
Accepts the following message:
Message IDCompleteOrderCommand.messageallOfEvent published when a user completes an order, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "totalMoney": 100 }
This example has been generated automatically.
SEND basket-checkout-complete
Event emitted when a user completes a basket checkout
Delete basket complete
Represents a successful integration event when deleting a basket in the system
Operation IDDeleteBasketCompleteCommandAvailable only on servers:
Accepts the following message:
Message IDDeleteBasketCompleteCommand.messageallOfEvent published when a basket is deleted and the order is complete, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
SEND basket-checkout-failed
Event emitted when a user fails to complete a basket checkout
Delete basket failed
Represents a failed integration event when deleting a basket in the system
Operation IDDeleteBasketFailedCommandAvailable only on servers:
Accepts the following message:
Message IDDeleteBasketFailedCommand.messageallOfEvent published when a basket is deleted and the order fails, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
SEND basket-place-order
Event emitted when a user places an order
Place order notification
Represents a successful integration event when placing an order in the system
Operation IDPlaceOrderCommandAvailable only on servers:
Accepts the following message:
Message IDPlaceOrderCommand.messageallOfEvent published when a user places an order, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
RECEIVE BookWorm.Contracts:BasketDeletedCompleteIntegrationEvent
Event emitted when a basket is deleted and the order is complete
Basket deleted complete
Represents a successful integration event when deleting a basket in the system
Operation IDBasketDeletedCompleteIntegrationEventAvailable only on servers:
Accepts the following message:
Message IDBasketDeletedCompleteIntegrationEvent.messageallOfEvent consumed when a basket is deleted and the order is complete, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
RECEIVE BookWorm.Contracts:BasketDeletedFailedIntegrationEvent
Event emitted when a basket is deleted and the order fails
Basket deleted failed
Represents a failed integration event when deleting a basket in the system
Operation IDBasketDeletedFailedIntegrationEventAvailable only on servers:
Accepts the following message:
Message IDBasketDeletedFailedIntegrationEvent.messageallOfEvent consumed when a basket is deleted and the order fails, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
RECEIVE BookWorm.Contracts:OrderStatusChangedToCompleteIntegrationEvent
Event emitted when the order status is changed to complete
Order status changed to cancel
Represents a successful integration event when the order status is changed to cancel in the system
Operation IDOrderStatusChangedToCancelIntegrationEventAvailable only on servers:
Accepts the following message:
Message IDOrderStatusChangedToCompleteIntegrationEvent.messageallOfEvent consumed when the order status is changed to complete, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
RECEIVE BookWorm.Contracts:UserCheckedOutIntegrationEvent
Event emitted when a user checks out
User checked out
Represents a successful integration event when a user checks out in the system
Operation IDUserCheckedOutIntegrationEventAvailable only on servers:
Accepts the following message:
Message IDUserCheckedOutIntegrationEvent.messageallOfEvent consumed when a user checks out, containing details about the order
Examples
{ "id": "01961eb4-668d-7e7e-ae25-0fab379614f7", "creationDate": "2021-01-01T00:00:00Z", "basketId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "email": "test@test.com", "orderId": "01961eb4-668d-7e7e-ae25-0fab379614f7", "totalMoney": 100 }
This example has been generated automatically.
Messages
- #1Message IDCancelOrderCommandallOf
Event published when a user cancels an order, containing details about the order
- #2Message IDCompleteOrderCommandallOf
Event published when a user completes an order, containing details about the order
- #3Message IDDeleteBasketCompleteCommandallOf
Event published when a basket is deleted and the order is complete, containing details about the order
- #4Message IDDeleteBasketFailedCommandallOf
Event published when a basket is deleted and the order fails, containing details about the order
- #5Message IDPlaceOrderCommandallOf
Event published when a user places an order, containing details about the order
- #6Message IDBasketDeletedCompleteIntegrationEventallOf
Event consumed when a basket is deleted and the order is complete, containing details about the order
- #7Message IDBasketDeletedFailedIntegrationEventallOf
Event consumed when a basket is deleted and the order fails, containing details about the order
- #8Message IDOrderStatusChangedToCancelIntegrationEventallOf
Event consumed when the order status is changed to cancel, containing details about the order
- #9Message IDOrderStatusChangedToCompleteIntegrationEventallOf
Event consumed when the order status is changed to complete, containing details about the order
- #10Message IDUserCheckedOutIntegrationEventallOf
Event consumed when a user checks out, containing details about the order
Schemas
- object
Base event structure containing common metadata for all integration events in the system
- allOf
Event published when a user cancels an order, containing details about the order
- allOf
Event published when a user completes an order, containing details about the order
- allOf
Event published when a basket is deleted and the order is complete, containing details about the order
- allOf
Event published when a basket is deleted and the order fails, containing details about the order
- allOf
Event published when a user places an order, containing details about the order
- allOf
Event consumed when a basket is deleted and the order is complete, containing details about the order
- allOf
Event consumed when a basket is deleted and the order fails, containing details about the order
- allOf
Event consumed when the order status is changed to cancel, containing details about the order
- allOf
Event consumed when the order status is changed to complete, containing details about the order
- allOf
Event consumed when a user checks out, containing details about the order