Order Service API

Auto-generated from NestJS controller decorators. Last synced: 2026-03-15

Base path: /api
Endpoints: 15

Order Analytics

Get order analytics and metrics

GET/orders/analyticsBearer token

Health

Liveness probe

GET/health

Readiness probe

GET/ready

Orders

Create order and submit for payment

POST/ordersBearer token

Request Body: CreateOrderDto

customerIdstringRequired

—

itemsCreateOrderItemDto[]Required

—

totalAmountnumberRequired

—

currencystringRequired

—

Start validation and provisioning for a paid order

POST/orders/:id/start-provisioningBearer token

idstringRequired

path parameter

Submit order for payment

POST/orders/:id/submitBearer token

idstringRequired

path parameter

Confirm payment for an order

POST/orders/:id/confirm-paymentBearer token

idstringRequired

path parameter

Request Body: ConfirmPaymentDto

transactionRefstringRequired

—

amountnumberRequired

—

currencystringRequired

—

Revert payment confirmation back to pending

POST/orders/:id/revert-paymentBearer token

idstringRequired

path parameter

Cancel an order

POST/orders/:id/cancelBearer token

idstringRequired

path parameter

Request Body: CancelOrderDto

reasonstringRequired

—

List orders with filtering, sorting and pagination

GET/ordersBearer token

queryQueryOrdersDtoRequired

query parameter

Get order analytics and metrics

GET/orders/analyticsBearer token

Get order statistics (counts by status, totals)

GET/orders/statsBearer token

Get order by ID

GET/orders/:idBearer token

idstringRequired

path parameter

Get delivery info for an order item

GET/orders/:id/items/:itemId/deliveryBearer token

idstringRequired

path parameter

itemIdstringRequired

path parameter

Send or re-send delivery email for an order item

POST/orders/:id/items/:itemId/deliverBearer token

idstringRequired

path parameter

itemIdstringRequired

path parameter