Ordering Service
A microservice for order management.
API
This microservice exposes the following gRPC endpoints:
Order
A Order resource.
io.restorecommerce.order.Order
| Field | Type | Label | Description |
|---|---|---|---|
id |
string |
required |
Order ID, unique, key |
meta |
required |
Meta info |
|
name |
string |
required |
Name |
description |
string |
optional |
description |
A list of Order resources:
io.restorecommerce.order.OrderList
| Field | Type | Label | Description |
|---|---|---|---|
items |
|
required |
List of Orders |
total_count |
number |
optional |
number of Orders |
CRUD Operations
The microservice exposes the below CRUD operations for creating or modifying Order and Role resources.
io.restorecommerce.order.Service
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
Create |
|
|
Create a list of Order resources |
Read |
|
|
Read a list of Order resources |
Update |
|
|
Update a list of Order resources |
Delete |
|
Empty |
Delete a list of Order resources |
Upsert |
|
|
Create or Update a list of Order resources |
For the detailed protobuf message structure of
io.restorecommerce.resourcebase.ReadRequest and io.restorecommerce.resourcebase.DeleteRequest
refer resource-base-interface.
Events
Emitted
List of events emitted by this microservice for below topics:
| Topic Name | Event Name | Description |
|---|---|---|
|
|
order created |
|
order modified |
|
|
order deleted |
Consumed
This microservice consumes messages for the following events by topic:
| Topic Name | Event Name | Description |
|---|---|---|
|
|
for triggering for system restore |
|
for triggering system reset |
|
|
to get system health check |
|
|
to get system version |