E-Commerce Order Platform
Complete walkthrough of the E-Commerce Order Platform gRPC API with three services, eight methods, and all four streaming patterns.
The E-Commerce Order Platform is a fully-documented gRPC API that demonstrates NeoArc's complete gRPC feature set. It includes three services, eight methods covering all four streaming patterns, Protocol Buffer message schemas, interceptor chains, HTTP transcoding, structured error handling, and retry policies.
Services
The API is organised into three services, each with its own interceptor chain and set of methods.
OrderService
Order lifecycle from creation through fulfilment. 4 methods: CreateOrder, GetOrder, ListOrders, UpdateOrderStatus.
ProductCatalogService
Product browsing, search, and bulk management. 3 methods: GetProduct, SearchProducts, BulkImportProducts.
NotificationService
Real-time event streaming for order and product updates. 1 method: SubscribeNotifications.
Method Summary
| Method | Service | Streaming | Description |
|---|---|---|---|
| CreateOrder | OrderService | Unary | Create a new order with stock validation and idempotency |
| GetOrder | OrderService | Unary | Retrieve an order by ID |
| ListOrders | OrderService | Server Streaming | Stream orders with filters and pagination |
| UpdateOrderStatus | OrderService | Unary | Transition order status with validation |
| GetProduct | ProductCatalogService | Unary | Retrieve a product by ID (cached) |
| SearchProducts | ProductCatalogService | Server Streaming | Full-text search with streaming results |
| BulkImportProducts | ProductCatalogService | Client Streaming | Bulk product upsert via streaming |
| SubscribeNotifications | NotificationService | Bidirectional | Real-time event subscription with dynamic filters |
OrderService Methods
ProductCatalogService Methods
NotificationService Methods
Proto Export
This entire API can be exported to .proto IDL files using NeoArc's export feature. The exported files include all services, methods, messages, enums, and options - ready to use with protoc for code generation.