I’ve been utilizing Claude Code for a wide range of functions, and one factor I’ve realized is that the extra it understands concerning the performance of the system (the area, the use instances, the end-to-end flows), the extra it may assist me.
For instance, once I paste a manufacturing error log, Claude can learn the stack hint, determine the affected code, and inform me if there’s a bug. However when the difficulty is extra advanced, like a buyer assist ticket, and there’s no stack hint, Claude is much less helpful.
The principle problem is that end-to-end processes are lengthy and complicated, spanning many code repositories. So simply asking Claude Code to investigate a single repository wasn’t going to work (and the default /init wasn’t producing enough element even for this single codebase).
So I made a decision to make use of Claude Code to investigate the system to map out the end-to-end flows related to the area I work in in order that Claude Code (and people) can use this to deal with extra advanced challenges.
This put up shares what I knocked collectively in sooner or later, constructing on data and tooling I’ve already gained from actual work examples and experiments.
That is one put up in a collection. You will discover the opposite posts right here:
https://medium.com/nick-tune-tech-strategy-blog/software-architecture-as-living-documentation-series-index-post-9f5ff1d3dc07
This put up was written 100% by me. I requested Claude to generate the anonymized instance on the finish mirroring the kind of content material and magnificence utilized in the actual examples I created.
Setting the Preliminary Context
To start my undertaking, I created a really gentle necessities doc:
# AI Structure Evaluation
This doc incorporates the directions for an necessary activity - utilizing AI to outline the structure of this method, in order that it may be utilized by people and AI brokers to extra simply perceive the system.
## Goal
Map out the entire flows that this software is concerned in (use sub brokers the place essential to work in parallel). A move ought to map out the end-to-process from an motion within the UI (within the [readacted] repo) to a BFF, to backend APIs, or flows which might be triggered by occasions.
Flows ought to be documented in Mermaid format to permit AI brokers to know, for versioning (in git), and for straightforward visualization.
## Necessities
Every move ought to have a descriptive identify and may embody:
1. The URL path of the web page the place the interplay is triggered
2. The URL path of the BFF endpoint (and the repository it lives in)
3. The URL path of calls made to downstream providers
4. Any database interactions
5. Any occasions produced or consumed (full identify of occasion e.g. orders.orderPlaced)
6. Shoppers of occasions (if simple to determine)
7. Any workflows triggered (just like the synchronizeOrder)
To do that, you'll need to look in different repositories which could be discovered within the mother or father folder. The GitHub shopper can be used if essential.
The checklist of flows ought to reside in ../flows/index.md and every particular person move ought to be outlined in a separate folder.
# The place to search out info
- /docs/structure incorporates numerous folders describing the design of this method and area data
- Every API undertaking on this repository ([redacted], [redacted]) has an openapi.json. This should be used to determine all flows and validate. The [redacted] and [redacted] repositories even have openapi spec information
- The entities within the area [redacted], [redacted] [redacted] have methodology that clearly describe the area operations that may be carried out on them. Equally, every operation is invoke from a use case that clearly describes the use case
The output I would like is end-to-end flows like:
UI -> BFF -> API -> replace DB -> publish occasion -> handler -> use case -> publish occasion -> …
I don’t need 10 completely different sorts of structure diagrams and completely different ranges of element. I would like Claude Code to know the habits of the system so it may determine anomalies (by manufacturing information and logs) and analyze the affect of potential adjustments.
I additionally created some gentle details about the system in these two information:
The area ideas file explains the entities within the system. Very transient clarification. The system overview file explains the connection between this codebase and different repositories, which is essential. Once more, it’s very gentle—a bullet checklist of repository names and one or two sentences describing their relationship to this one.
Looking out throughout a number of repositories
The directions for this activity reside inside the principle repository of the area I work in. That is the middle of the universe for this agent, however it wants to have the ability to learn different repositories to hitch up the end-to-end move.
The answer I exploit for that is within the description above:
To do that, you’ll need to look in different repositories which could be discovered within the mother or father folder. The GitHub shopper can be used if essential.
I give Claude the next permissions in .claude/settings.native.json and it may then entry all of the repositories on machine or use the GitHub shopper if it thinks there are repositories I don’t have accessible regionally:
"permissions": {"permit": [..."Read(//Users/nicktune/code/**)",...
Telling Claude where to look
You’ll notice the requirements also give Claude tips on where to look for key information like Open API spec files, which are like an index of the operations the application supports.
This is useful as a validation mechanism later in the flow. I would ask Claude, “List all of the API endpoints and events produced or consumed by this application—are there any that aren’t part of any flows.” I can then see if we may have missed anything important.
Mapping the First Flow
I put Claude in plan mode and asked it to read the file. It then popped up a short questionnaire asking me about my needs and preferences. One of the questions it asked was process related: Should we map out the whole system in parallel, work step-by-step, etc.?
I said, let’s do the first one together and use this as a template for the others to follow.
It took about two hours to build the first flow as I reviewed what Claude produced and gave feedback on what I needed. For example, at first it created a sequence diagram which looked nice but was too hard to read for complex flows that involve many repositories.
Eventually, we settled on horizontal flow diagrams where each repository is a container and we defined what steps could be. At first, it went too granular with the steps adding individual method calls.
### diagram.mermaid Requirements
**CRITICAL RULES:**
1. **File Format**: Must be pure Mermaid syntax with `.mermaid` extension- NO markdown headers
- NO markdown code fences (no ` ```mermaid ` wrapper)
- Starts directly with `flowchart LR`
2. **Use Swimlane Format**: `flowchart LR` (left-to-right with horizontal swimlanes)
- Each repository is a horizontal swimlane (subgraph)
- Flow progresses left to right
- Swimlane labels should be prominent (use emoji for visibility)
- Example: `subgraph systemA["🔧 systemA"]`
3. **Methods as Containers**:
- Every repository MUST be a `subgraph` (horizontal swimlane)
- Repository identify is the subgraph label
- Operations are nodes contained in the subgraph
- Use `course LR` inside every subgraph
4. **Legitimate Step Varieties** - A step within the diagram can ONLY be one of many following:
- **HTTP Endpoint**: Full endpoint path (e.g., `POST /blah/{blahId}/subblah`)
- **Combination Methodology Name**: Area methodology on an mixture (e.g., `Order.place`, `Delivery.organiz`)
- **Database Operation**: Proven with cylinder form `[(Database: INSERT order)]`
- **Occasion Publication**: (e.g., `Publish: personal.ordering.order.positioned`)
- **Workflow Set off**: Should be labeled as workflow (e.g., `⚙️ Workflow: syncOrders`)
- **Workflow Step**: Any step inside a workflow MUST embody the workflow identify as prefix (e.g., `syncOrderWorkflow: Replace legacy order`, `updateOrderInfo: POST /legacy/fill-order`)
- **Lambda Invocation**: (e.g., `Lambda: blah-blah-lambda-blah-blah`)
- **UI Actions**: Person interactions (e.g., `Present modal type`, `Person enters firstName, lastName`)
I’ve added an anonymized move on the finish of this doc.
I additionally had so as to add some corrections to Claude to make sure it was wanting in all the suitable locations and understanding what sure ideas imply in different components of our system; we weren’t simply iterating on the diagram for 2 hours.
Selecting the Subsequent Circulation
After the primary move, the subsequent flows went a lot quicker. I verified the output of every move and gave Claude suggestions, however typically round quarter-hour, and more often than not it was working so I might do different issues whereas ready.
One of many fascinating challenges was deciding which flows are literally wanted? What’s a move? The place ought to a move begin and finish? What about relationships between flows?
Right here I used to be within the driving seat fairly a bit. I requested Claude to suggest flows (simply checklist them earlier than analyzing) after which I requested it to point out me how every API endpoint and occasion match into the flows, and we used that to iterate a bit.
One of many issues I needed to do after Claude had produced the primary draft is to ask, “Are you certain there aren’t any different shoppers for these occasions that aren’t listed right here?” It could then do a extra thorough search and generally discover shoppers in repositories I didn’t have regionally. (It could use GitHub search.)
Studying worth
As I reviewed every use case, I used to be studying issues concerning the system that I didn’t absolutely perceive or perhaps there have been nuances I wasn’t conscious of. This alone would have justified all the hassle I spent on this.
Then I began to think about the worth for people who find themselves new to a codebase or a legacy system that no one understands anymore. Or perhaps somebody who works in a special staff and desires to determine how a bug or a change of their area is expounded to different domains.
Evolving the Necessities
As we went by means of the method, I recurrently informed Claude to replace the necessities file. So after we’d completed the primary move we had directions like this added to the file:
## Documentation Construction
Every move should be documented in a separate folder with the next construction:
```
docs/structure/flows/[flow-name]/
├── README.md # Full documentation (all content material in a single file)
└── diagram.mermaid # Mermaid diagram
```
**IMPORTANT**: Use ONLY these two information. Do NOT create separate diagram-notes.md or different information. Hold all documentation consolidated in README.md for simpler upkeep.
### README.md Contents
**Use the blueprint as a template**: `docs/structure/flows/[redacted]/`
The file is now 449 traces lengthy.
One of many causes I did this was in order that I might begin a brand new Claude session, now or sooner or later, with no fully clear context window and execute the method to get related outcomes.
I did truly use a brand new session to map every new move to validate that the necessities had been considerably repeatable. Basically they had been, however usually Claude would ignore some components of the necessities. So on the finish, I informed it to overview the necessities and evaluate the outputs, and it will often determine a lot of the errors it had made and repair them.
Right here’s an instance of a few of the guidelines that began to construct up. Some had been to make sure Claude produced the suitable sort of output, and a few had been to assist Claude keep away from widespread errors like Mermaid syntax errors.
### 2. Hint Workflows to Their Closing Occasion
**Downside**: Lacking occasions since you do not learn the precise workflow implementation.
**Rule**: Once you encounter a workflow, you MUST:
1. Discover the workflow definition file (often `.asl.json` for AWS Step Features)
2. Learn the ENTIRE workflow to see ALL occasions it publishes
3. Doc EVERY occasion in sequence
**Instance from our blueprint**:
- We initially thought `[readacted]` ended with `[readacted]`
- Studying `[redacted].asl.json` revealed it truly ends with `[readacted]`
- This occasion was CRITICAL to the move persevering with
**File places**:
– Integrations workflows: `[another-repo]/domains/*/workflows/*.asl.json`
– Search for `SendEvent` or `publish` actions within the workflow steps
Claude Code by no means follows each instruction as described. However including these guidelines does appear to extend the standard and scale back the variety of iterations wanted.
Testing the Output
After I mapped out 4 or 5 of the flows, I made a decision it was time to try it out—Does this info truly assist Claude Code, or is it primarily only a human viewers that advantages from the outputs?
So I went into our assist ticket system and picked a ticket that regarded advanced. I requested my investigation agent to have a look at the ticket and determine the issue. However this time I added an additional step into its directions:
4. Establish the affected flows in /docs/structure/flows
As a part of its evaluation, it stated:
Let me discover the structure flows to know how [redacted] and [redacted] ought to be dealt with:
Then it produced its evaluation appropriately figuring out the move and anticipated behaviors:
## Affected Circulation
**[BlahA Upload and BlahB History Thing](../structure/flows/[redacted]/README.md)**
The [redacted] workflow ought to populate [redacted] information through:
- [redacted] choice ([redacted] commonplace OR [redacted] enhanced based mostly on `[redacted]` flag)
- Parallel execution of: DomainA, DomainB, DomainC, DomainD
- Publishing `order.blahBlahed` occasion on completion
…
And for the subsequent steps, it wished to question the occasions printed by the system to confirm that what truly occurred matched the anticipated behaviors outlined within the move:
### Step 1: Question [redacted] Occasions for Each [redacted]
**Goal:** Evaluate occasion historical past to determine what occurred otherwise between outdated and new [redacted]
**What to search for:**
– `[redacted event name]` – Did [redacted] full for brand spanking new [redacted]?
– `[redacted event name]` – Have been [redacted] created?
– `[redacted event name]` – Have been [redacted] created?
– `[redacted event name]` – Did workflow full for brand spanking new [redacted]?
– `[redacted event name]` – Closing affirmation occasion
– Any error/failure occasions associated to the workflow
Beforehand, Claude would have needed to analyze the codebase to work out what ought to have occurred. It takes a very long time and takes up a whole lot of context window for advanced duties, and the evaluation must be verified.
Now, Claude is aware of instantly concerning the particular workflow and affected behaviors and may instantly start planning an investigation (if the documentation is correct sufficient). This evaluation is structured with the important thing info that I have to see. I don’t have to iterate with Claude to supply an evaluation within the format I would like.
On this case, Claude didn’t resolve the issue instantly, however the dialog was extra like I might need with a staff member—somebody who has a deeper understanding of how the system works and what could be flawed right here slightly than simply utilizing Claude to investigate patterns in information, learn stack traces, or summarize textual content descriptions of the issue.
Accuracy and Hallucinations
I do assume it’s proper to be involved about accuracy. We don’t need to make necessary selections about our system based mostly on incomplete or incorrect particulars. And there have been vital inaccuracies that I needed to spot and proper. (Think about if I didn’t know they had been flawed.)
I explored the problem of accuracy in this later put up displaying how we are able to use deterministic instruments likets-morphto construct the mannequin that people and AI can each profit from.
So right here’s what I’m considering:
- Typically we don’t want excellent accuracy. So long as the agent picks the suitable path, it may reinspect sure particulars or dive deeper as wanted.
- We will construct checks and steps in into our CI pipelines to replace issues.
- Commonly destroy and regenerate the flows (as soon as 1 / 4?).
- Construct verification brokers or swarms.
After I noticed an error and requested a brand new agent to investigate the move for inaccuracies, it rescanned the code and located what I noticed. So I feel choice 4 could be very credible—it’s simply extra effort to construct a verification system (which might make the general effort not value it).
However I’m unsure that is the optimum approach of approaching the scenario. As an alternative…
The Subsequent Section of Platform Engineering
Avoiding the necessity to reverse engineer these flows might be key. And I’m beginning to assume it will develop into the principle problem for platform engineering groups: How can we construct frameworks and tooling that expose our system as a graph of dependencies? Constructed into our platform in order that AI brokers don’t have to reverse engineer; they’ll simply seek the advice of the supply of fact.
Issues ought to all occur transparently for software program engineers—you observe the platform paved path, and all the things simply works. Firms that do that, and particularly startups with no legacy, might immensely revenue from AI brokers.
Instruments like EventCatalog are in a powerful place right here.
Instance Circulation
I simply requested Claude to translate one among my firm’s area flows right into a boring ecommerce instance. The design and naming shouldn’t be necessary; the kind of info and the visualization is what I’m attempting to convey.
Bear in mind, that is based mostly on sooner or later of hacking round. I’m certain there are many enchancment alternatives right here. Let me know when you have seen something higher.
The README
# Place Order with Fee and Success
**Standing**: Energetic
**Kind**: Write Operation
**Complexity**: Excessive
**Final Up to date**: 2025-10-19
## Overview
This move paperwork the method of putting an order in an ecommerce system, together with fee authorization, stock reservation, and cargo creation. That is the baseline order placement expertise the place:
– Orders begin with `standing: ‘pending’`
– Fee is permitted earlier than stock reservation
– Stock is reserved upon profitable fee
– Cargo is created after stock reservation
## Circulation Boundaries
**Begin**: Buyer clicks “Place Order” button on checkout web page
**Finish**: Publication of `transport.shipment-created` occasion (public occasion with `DOMAIN` scope)
**Scope**: This move covers your complete course of from preliminary order submission by means of fee authorization, stock reservation, cargo creation, and all asynchronous uncomfortable side effects triggered by these operations.
## Fast Reference
### API Endpoints
| Endpoint | Methodology | Repository | Goal |
|———-|——–|————|———|
| `/checkout` | GET | storefront-app | Checkout web page |
| `/api/orders` | POST | order-api | Creates order |
| `/api/funds/authorize` | POST | payment-api | Authorizes fee |
| `/api/stock/reserve` | POST | inventory-api | Reserves stock |
| `/api/shipments` | POST | shipping-api | Creates cargo |
| `/api/orders/{orderId}/standing` | GET | order-api | Frontend polls for order standing |
### Occasions Reference
| Occasion Identify | Area | Topic | Goal | Shoppers |
|————|——–|———|———|———–|
| `personal.orders.order.created` | ORDERS | order | Order creation | PaymentHandler, AnalyticsHandler |
| `personal.funds.fee.licensed` | PAYMENTS | fee | Fee licensed | InventoryReservationHandler |
| `personal.funds.fee.failed` | PAYMENTS | fee | Fee failed | OrderCancellationHandler |
| `personal.stock.inventory.reserved` | INVENTORY | inventory | Stock reserved | ShipmentCreationHandler |
| `personal.stock.inventory.inadequate` | INVENTORY | inventory | Inadequate inventory | OrderCancellationHandler |
| `personal.transport.cargo.created` | SHIPPING | cargo | Cargo created | NotificationHandler |
| `transport.shipment-created` | SHIPPING | cargo | **PUBLIC** Cargo created | Exterior shoppers |
### Database Tables
| Desk | Operation | Key Fields | Goal |
|——-|———–|————|———|
| `orders` | INSERT | orderId, customerId, standing=”pending”, totalAmount | Order mixture storage |
| `order_items` | INSERT | orderItemId, orderId, productId, amount, worth | Order line gadgets |
| `funds` | INSERT | paymentId, orderId, quantity, standing=”licensed” | Fee mixture storage |
| `inventory_reservations` | INSERT | reservationId, orderId, productId, amount | Stock reservation monitoring |
| `shipments` | INSERT | shipmentId, orderId, trackingNumber, standing=”pending” | Cargo mixture storage |
### Area Operations
| Combination | Methodology | Goal |
|———–|——–|———|
| Order | `Order.create()` | Creates new order with pending standing |
| Order | `Order.confirmPayment()` | Marks fee as confirmed |
| Order | `Order.cancel()` | Cancels order as a consequence of fee or stock failure |
| Fee | `Fee.authorize()` | Authorizes fee for order |
| Fee | `Fee.seize()` | Captures licensed fee |
| Stock | `Stock.reserve()` | Reserves inventory for order |
| Cargo | `Cargo.create()` | Creates cargo for order |
## Key Traits
| Side | Worth |
|——–|——-|
| Order Standing | Makes use of `standing` subject: `’pending’` → `’confirmed’` → `’shipped’` |
| Fee Standing | Makes use of `standing` subject: `’pending’` → `’licensed’` → `’captured’` |
| Stock Technique | Reserve-on-payment method |
| Cargo Standing | Makes use of `standing` subject: `’pending’` → `’prepared’` → `’shipped’` |
## Circulation Steps
1. **Buyer** navigates to checkout web page in storefront-app (`/checkout`)
2. **Buyer** evaluations order particulars and clicks “Place Order” button
3. **storefront-app UI** reveals loading state with order affirmation message
4. **storefront-app** sends POST request to order-api (`/api/orders`)
– Request consists of: customerId, gadgets (productId, amount, worth), shippingAddress, billingAddress
5. **order-api** creates Order mixture with `standing: ‘pending’` and persists to database
6. **order-api** creates OrderItem data for every merchandise within the order
7. **order-api** publishes `personal.orders.order.created` occasion
8. **order-api** returns orderId and order particulars to storefront-app
9. **storefront-app** redirects buyer to order affirmation web page
### Asynchronous Facet Results – Fee Processing
10. **order-events-consumer** receives `personal.orders.order.created` occasion
11. **PaymentHandler** processes the occasion
– Calls payment-api to authorize fee
12. **payment-api** calls exterior fee gateway (Stripe, PayPal, and so forth.)
13. **payment-api** creates Fee mixture with `standing: ‘licensed’` and persists to database
14. **payment-api** publishes `personal.funds.fee.licensed` occasion (on success)
– OR publishes `personal.funds.fee.failed` occasion (on failure)
### Asynchronous Facet Results – Stock Reservation
15. **payment-events-consumer** receives `personal.funds.fee.licensed` occasion
16. **InventoryReservationHandler** processes the occasion
– Calls inventory-api to order inventory
17. **inventory-api** hundreds Stock mixture for every product
18. **inventory-api** calls `Stock.reserve()` for every order merchandise
– Validates enough inventory accessible
– Creates reservation report
– Decrements accessible inventory
19. **inventory-api** creates InventoryReservation data and persists to database
20. **inventory-api** publishes `personal.stock.inventory.reserved` occasion (on success)
– OR publishes `personal.stock.inventory.inadequate` occasion (on failure)
### Asynchronous Facet Results – Cargo Creation
21. **inventory-events-consumer** receives `personal.stock.inventory.reserved` occasion
22. **ShipmentCreationHandler** processes the occasion
– Calls shipping-api to create cargo
23. **shipping-api** creates Cargo mixture with `standing: ‘pending’` and persists to database
24. **shipping-api** calls exterior transport provider API to generate monitoring quantity
25. **shipping-api** updates Cargo with trackingNumber
26. **shipping-api** publishes `personal.transport.cargo.created` occasion
27. **shipping-events-consumer** receives `personal.transport.cargo.created` occasion
– **ShipmentCreatedPublicHandler** processes the occasion
– Masses cargo from repository to get full cargo particulars
– Publishes public occasion: `transport.shipment-created`
– **This marks the END of the move**
### Order Standing Updates
28. All through the move, order-api receives occasions and updates order standing:
– On `personal.funds.fee.licensed`: Updates order with paymentId
– On `personal.stock.inventory.reserved`: Updates order to `standing: ‘confirmed’`
– On `personal.transport.cargo.created`: Updates order to `standing: ‘shipped’`
### Failure Eventualities
**Fee Failure**:
– On `personal.funds.fee.failed`: OrderCancellationHandler cancels order
– Order standing up to date to `’cancelled’`
– Buyer notified through e-mail
**Stock Failure**:
– On `personal.stock.inventory.inadequate`: OrderCancellationHandler cancels order
– Fee authorization is voided
– Order standing up to date to `’cancelled’`
– Buyer notified through e-mail with choice to backorder
## Repositories Concerned
– **storefront-app**: Frontend UI
– **order-api**: Order area
– **payment-api**: Fee area
– **inventory-api**: Stock area
– **shipping-api**: Delivery and success area
– **notification-api**: Buyer notifications
## Associated Flows
– **Course of Refund**: Circulation for dealing with order refunds and returns
– **Replace Cargo Standing**: Circulation for monitoring cargo supply standing
– **Stock Reconciliation**: Circulation for syncing stock counts with warehouse techniques
## Occasions Produced
| Occasion | Goal |
|——-|———|
| `personal.orders.order.created` | Notifies {that a} new order has been created |
| `personal.funds.fee.licensed` | Notifies that fee has been licensed |
| `personal.funds.fee.failed` | Notifies that fee authorization failed |
| `personal.stock.inventory.reserved` | Notifies that stock has been reserved |
| `personal.stock.inventory.inadequate` | Notifies that inadequate stock is accessible |
| `personal.transport.cargo.created` | Inner occasion that cargo has been created |
| `transport.shipment-created` | **Public occasion** that cargo is created and prepared for provider pickup |
## Occasion Shoppers
### `personal.orders.order.created` Shoppers
#### 1. order-events-consumer
**Handler**: `PaymentHandler`
**Goal**: Initiates fee authorization course of
**Actions**:
– Subscribes to occasion
– Calls `AuthorizePayment` use case
– Invokes payment-api to authorize fee with fee gateway
– Publishes fee consequence occasion
#### 2. order-events-consumer
**Handler**: `AnalyticsHandler`
**Goal**: Tracks order creation for analytics
**Actions**:
– Subscribes to occasion
– Sends order information to analytics platform
– Updates conversion monitoring
### `personal.funds.fee.licensed` Client
#### payment-events-consumer
**Handler**: `InventoryReservationHandler`
**Goal**: Reserves stock after profitable fee
**Actions**:
– Subscribes to occasion
– Calls `ReserveInventory` use case
– Masses order particulars
– Calls inventory-api to order inventory for every merchandise
– Publishes stock reservation consequence occasion
### `personal.funds.fee.failed` Client
#### payment-events-consumer
**Handler**: `OrderCancellationHandler`
**Goal**: Cancels order when fee fails
**Actions**:
– Subscribes to occasion
– Calls `CancelOrder` use case
– Updates order standing to ‘cancelled’
– Triggers buyer notification
### `personal.stock.inventory.reserved` Client
#### inventory-events-consumer
**Handler**: `ShipmentCreationHandler`
**Goal**: Creates cargo after stock reservation
**Actions**:
– Subscribes to occasion
– Calls `CreateShipment` use case
– Calls shipping-api to create cargo report
– Integrates with transport provider API for monitoring quantity
– Publishes cargo created occasion
### `personal.stock.inventory.inadequate` Client
#### inventory-events-consumer
**Handler**: `OrderCancellationHandler`
**Goal**: Cancels order when stock is inadequate
**Actions**:
– Subscribes to occasion
– Calls `CancelOrder` use case
– Voids fee authorization
– Updates order standing to ‘cancelled’
– Triggers buyer notification with backorder choice
### `personal.transport.cargo.created` Client
#### shipping-events-consumer
**Handler**: `ShipmentCreatedPublicHandler`
**Goal**: Converts personal cargo occasion to public occasion
**Actions**:
– Subscribes to `personal.transport.cargo.created` occasion
– Masses cargo from repository
– Publishes public occasion: `transport.shipment-created`
**Handler**: `NotificationHandler`
**Goal**: Notifies buyer of cargo creation
**Actions**:
– Subscribes to occasion
– Sends affirmation e-mail with monitoring quantity
– Sends SMS notification (if opted in)
## Database Operations
### orders Desk
– **Operation**: INSERT (through upsert)
– **Key Fields**: orderId, customerId, standing=”pending”, totalAmount, createdAt
– **Repository**: `OrderRepository`
### order_items Desk
– **Operation**: INSERT (batch)
– **Key Fields**: orderItemId, orderId, productId, amount, worth
– **Repository**: `OrderItemRepository`
### funds Desk
– **Operation**: INSERT (through upsert)
– **Key Fields**: paymentId, orderId, quantity, standing=”licensed”, gatewayTransactionId
– **Repository**: `PaymentRepository`
### inventory_reservations Desk
– **Operation**: INSERT (through upsert)
– **Key Fields**: reservationId, orderId, productId, amount, reservedAt
– **Repository**: `InventoryReservationRepository`
### shipments Desk
– **Operation**: INSERT (through upsert)
– **Key Fields**: shipmentId, orderId, trackingNumber, standing=”pending”, provider
– **Repository**: `ShipmentRepository`
## Exterior Integrations
– **Fee Gateway Integration**: Authorizes and captures funds through Stripe API
– Endpoint: `/v1/payment_intents`
– Synchronous name throughout fee authorization
– **Delivery Service Integration**: Generates monitoring numbers through provider API
– Endpoint: `/api/v1/shipments`
– Synchronous name throughout cargo creation
## What Occurs After This Circulation
This move ends with the publication of the `transport.shipment-created` public occasion, which marks the order as absolutely processed and prepared for provider pickup.
### State at Circulation Completion
– Order: `standing: ‘shipped’`
– Fee: `standing: ‘licensed’` (might be captured on precise cargo)
– Stock: Inventory reserved and decremented
– Cargo: `standing: ‘pending’`, trackingNumber assigned
### Subsequent Steps
After this move completes:
– Warehouse staff picks and packs the order
– Service picks up the cargo
– Delivery standing updates move tracks supply
– Fee is captured upon confirmed cargo
– Buyer can observe order through monitoring quantity
### Exterior System Integration
As soon as the `transport.shipment-created` occasion is printed:
– Warehouse administration system begins decide/pack course of
– Buyer notification system sends monitoring updates
– Logistics companions obtain cargo manifest
– Analytics techniques observe success metrics
## Diagram
See [diagram.mermaid](./diagram.mermaid) for the entire visible move displaying the development by means of techniques with horizontal swim lanes for every service.
The Mermaid:
flowchart LR
Begin([Customer clicks Place Order
on checkout page])
subgraph storefront[“🌐 storefront-app”]
course LR
ShowCheckout[Show checkout page]
CustomerReview[Customer reviews order]
ShowConfirmation[Show order
confirmation page]
finish
CustomerWaitsForShipment([Customer receives
shipment notification])
subgraph orderService[“📦 order-api”]
course LR
CreateOrderEndpoint[“POST /api/orders”]
OrderCreate[Order.create]
OrderDB[(Database:
INSERT orders,
order_items)]
PublishOrderCreated[“Publish: private.orders
.order.created”]
ReceivePaymentAuth[“Receive: private.payments
.payment.authorized”]
UpdateOrderPayment[Update order
with paymentId]
ReceiveStockReserved[“Receive: private.inventory
.stock.reserved”]
OrderConfirm[Order.confirmPayment]
UpdateOrderConfirmed[(Database:
UPDATE orders
status=”confirmed”)]
ReceiveShipmentCreated[“Receive: private.shipping
.shipment.created”]
UpdateOrderShipped[(Database:
UPDATE orders
status=”shipped”)]
finish
subgraph paymentService[“💳 payment-api”]
course LR
ReceiveOrderCreated[“Receive: private.orders
.order.created”]
AuthorizeEndpoint[“POST /api/payments/
authorize”]
PaymentGateway[“External: Payment
Gateway API
(Stripe)”]
PaymentAuthorize[Payment.authorize]
PaymentDB[(Database:
INSERT payments)]
PublishPaymentAuth[“Publish: private.payments
.payment.authorized”]
finish
subgraph inventoryService[“📊 inventory-api”]
course LR
ReceivePaymentAuth2[“Receive: private.payments
.payment.authorized”]
ReserveEndpoint[“POST /api/inventory/
reserve”]
InventoryReserve[Inventory.reserve]
InventoryDB[(Database:
INSERT inventory_reservations
UPDATE product stock)]
PublishStockReserved[“Publish: private.inventory
.stock.reserved”]
finish
subgraph shippingService[“🚚 shipping-api”]
course LR
ReceiveStockReserved2[“Receive: private.inventory
.stock.reserved”]
CreateShipmentEndpoint[“POST /api/shipments”]
CarrierAPI[“External: Shipping
Carrier API
(FedEx/UPS)”]
ShipmentCreate[Shipment.create]
ShipmentDB[(Database:
INSERT shipments)]
PublishShipmentCreated[“Publish: private.shipping
.shipment.created”]
ReceiveShipmentCreatedPrivate[“Receive: private.shipping
.shipment.created”]
LoadShipment[Load shipment
from repository]
PublishPublicEvent[“Publish: shipping
.shipment-created”]
FlowEnd([Flow End:
Public event published])
finish
Begin –> ShowCheckout
ShowCheckout –> CustomerReview
CustomerReview –> CreateOrderEndpoint
CreateOrderEndpoint –> OrderCreate
OrderCreate –> OrderDB
OrderDB –> PublishOrderCreated
PublishOrderCreated –> ShowConfirmation
PublishOrderCreated -.-> ReceiveOrderCreated
ReceiveOrderCreated –> AuthorizeEndpoint
AuthorizeEndpoint –> PaymentGateway
PaymentGateway –> PaymentAuthorize
PaymentAuthorize –> PaymentDB
PaymentDB –> PublishPaymentAuth
PublishPaymentAuth -.-> ReceivePaymentAuth
ReceivePaymentAuth –> UpdateOrderPayment
PublishPaymentAuth -.-> ReceivePaymentAuth2
ReceivePaymentAuth2 –> ReserveEndpoint
ReserveEndpoint –> InventoryReserve
InventoryReserve –> InventoryDB
InventoryDB –> PublishStockReserved
PublishStockReserved -.-> ReceiveStockReserved
ReceiveStockReserved –> OrderConfirm
OrderConfirm –> UpdateOrderConfirmed
PublishStockReserved -.-> ReceiveStockReserved2
ReceiveStockReserved2 –> CreateShipmentEndpoint
CreateShipmentEndpoint –> CarrierAPI
CarrierAPI –> ShipmentCreate
ShipmentCreate –> ShipmentDB
ShipmentDB –> PublishShipmentCreated
PublishShipmentCreated -.-> ReceiveShipmentCreated
ReceiveShipmentCreated –> UpdateOrderShipped
PublishShipmentCreated -.-> ReceiveShipmentCreatedPrivate
ReceiveShipmentCreatedPrivate –> LoadShipment
LoadShipment –> PublishPublicEvent
PublishPublicEvent –> FlowEnd
FlowEnd -.-> CustomerWaitsForShipment
type Begin fill:#e1f5e1
type FlowEnd fill:#ffe1e1
type CustomerWaitsForShipment fill:#e1f5e1
type PublishOrderCreated fill:#fff4e1
type PublishPaymentAuth fill:#fff4e1
type PublishStockReserved fill:#fff4e1
type PublishShipmentCreated fill:#fff4e1
type PublishPublicEvent fill:#fff4e1
type OrderDB fill:#e1f0ff
type PaymentDB fill:#e1f0ff
type InventoryDB fill:#e1f0ff
type ShipmentDB fill:#e1f0ff
type UpdateOrderConfirmed fill:#e1f0ff
type UpdateOrderShipped fill:#e1f0ff
type PaymentGateway fill:#ffe1f5
type CarrierAPI fill:#ffe1f5