Traders Welfare Logistics — API

NestJS REST API · prefix /api/v1 · port 4000 · production

All dependencies healthy uptime 14h 30m PostgreSQL 15 ms Redis 32 ms
This is an API, not a website — every endpoint below answers JSON. The machine-readable health check lives at /api/v1/health. The customer, rider and admin screens run on the web app (port 5173 when it is started).

External services

Reported by the server's own configuration, not by the page.

Routes the server actually registered (201)

Read from the live router at request time, so this list cannot drift from the code.

admin
GET /api/v1/admin/audit-logs
GET /api/v1/admin/customers
POST /api/v1/admin/customers/:id/status
GET /api/v1/admin/dashboard
GET /api/v1/admin/deliveries
GET /api/v1/admin/deliveries/:id
POST /api/v1/admin/deliveries/:id/assign
POST /api/v1/admin/deliveries/:id/cancel
GET /api/v1/admin/deliveries/export.csv
GET /api/v1/admin/dispatch/board
POST /api/v1/admin/dispatch/deliveries/:id/run
GET /api/v1/admin/finance/payments
POST /api/v1/admin/finance/payments/:paymentId/refunds
GET /api/v1/admin/finance/reconciliation
GET /api/v1/admin/finance/refunds
GET /api/v1/admin/finance/summary
GET /api/v1/admin/finance/withdrawals
POST /api/v1/admin/finance/withdrawals/:id/approve
POST /api/v1/admin/finance/withdrawals/:id/payout
POST /api/v1/admin/finance/withdrawals/:id/reject
GET /api/v1/admin/invites
POST /api/v1/admin/invites
DELETE /api/v1/admin/invites/:id
GET /api/v1/admin/locations
POST /api/v1/admin/locations
DELETE /api/v1/admin/locations/:id
PATCH /api/v1/admin/locations/:id
GET /api/v1/admin/permissions
GET /api/v1/admin/pricing
POST /api/v1/admin/pricing/rules/:id
GET /api/v1/admin/reports
POST /api/v1/admin/reports
GET /api/v1/admin/reports/:id
POST /api/v1/admin/reports/:id/download-link
GET /api/v1/admin/reports/catalogue
GET /api/v1/admin/reports/preview
GET /api/v1/admin/riders
GET /api/v1/admin/riders/:id
POST /api/v1/admin/riders/:id/approval
GET /api/v1/admin/riders/:id/documents/:documentId/file
POST /api/v1/admin/riders/:id/documents/:documentId/review
GET /api/v1/admin/roles
GET /api/v1/admin/staff
GET /api/v1/admin/team
POST /api/v1/admin/team
POST /api/v1/admin/team/:id/status
GET /api/v1/admin/tracking/live
GET /api/v1/admin/whoami
auth
GET /api/v1/auth/invites/:token
POST /api/v1/auth/invites/:token/accept
POST /api/v1/auth/login
POST /api/v1/auth/logout
POST /api/v1/auth/logout-all
GET /api/v1/auth/me
PATCH /api/v1/auth/me
DELETE /api/v1/auth/me/avatar
POST /api/v1/auth/me/avatar
POST /api/v1/auth/otp/request
POST /api/v1/auth/otp/verify
PATCH /api/v1/auth/password
POST /api/v1/auth/password/forgot
POST /api/v1/auth/password/reset
POST /api/v1/auth/refresh
POST /api/v1/auth/register/customer
POST /api/v1/auth/register/rider
POST /api/v1/auth/resend-verification
POST /api/v1/auth/resend-verification-email
GET /api/v1/auth/sessions
DELETE /api/v1/auth/sessions/others
POST /api/v1/auth/verify-email
deliveries
GET /api/v1/deliveries
POST /api/v1/deliveries
GET /api/v1/deliveries/:id
POST /api/v1/deliveries/:id/cancel
GET /api/v1/deliveries/:id/contact
POST /api/v1/deliveries/:id/contact/call
GET /api/v1/deliveries/:id/messages
POST /api/v1/deliveries/:id/messages
GET /api/v1/deliveries/:id/package-photo
GET /api/v1/deliveries/:id/share-link
POST /api/v1/deliveries/:id/share-link
POST /api/v1/deliveries/:id/share-link/revoke
GET /api/v1/deliveries/:id/track
POST /api/v1/deliveries/package-photo
POST /api/v1/deliveries/quote
GET /api/v1/deliveries/summary
files
GET /api/v1/files/avatars/:file
health
GET /api/v1/health
GET /api/v1/health/live
maps
GET /api/v1/maps/geocode
GET /api/v1/maps/locations
GET /api/v1/maps/places
GET /api/v1/maps/reverse
payments
GET /api/v1/payments
GET /api/v1/payments/:reference
POST /api/v1/payments/:reference/simulate
POST /api/v1/payments/:reference/verify
GET /api/v1/payments/config
POST /api/v1/payments/deliveries/:deliveryId/initialize
POST /api/v1/payments/deliveries/:deliveryId/pay-with-wallet
POST /api/v1/payments/wallet/topups
reports
GET /api/v1/reports/download/:token
rider
POST /api/v1/rider/availability
GET /api/v1/rider/documents
POST /api/v1/rider/documents
GET /api/v1/rider/earnings
GET /api/v1/rider/jobs
GET /api/v1/rider/jobs/:id
POST /api/v1/rider/jobs/:id/arrive-destination
POST /api/v1/rider/jobs/:id/arrive-pickup
POST /api/v1/rider/jobs/:id/complete
POST /api/v1/rider/jobs/:id/fail
POST /api/v1/rider/jobs/:id/pickup
POST /api/v1/rider/jobs/:id/proof-photo
POST /api/v1/rider/jobs/:id/start-transit
GET /api/v1/rider/jobs/active
POST /api/v1/rider/location
GET /api/v1/rider/location/config
GET /api/v1/rider/offers
POST /api/v1/rider/offers/:id/accept
POST /api/v1/rider/offers/:id/reject
GET /api/v1/rider/profile
GET /api/v1/rider/withdrawals
POST /api/v1/rider/withdrawals
root
ACL /api/v1
ACL /api/v1
BIND /api/v1
BIND /api/v1
CHECKOUT /api/v1
CHECKOUT /api/v1
CONNECT /api/v1
CONNECT /api/v1
COPY /api/v1
COPY /api/v1
DELETE /api/v1
DELETE /api/v1
GET /api/v1
GET /api/v1
HEAD /api/v1
HEAD /api/v1
/api/v1
/api/v1
LOCK /api/v1
LOCK /api/v1
/api/v1
/api/v1
MERGE /api/v1
MERGE /api/v1
MKACTIVITY /api/v1
MKACTIVITY /api/v1
MKCALENDAR /api/v1
MKCALENDAR /api/v1
MKCOL /api/v1
MKCOL /api/v1
MOVE /api/v1
MOVE /api/v1
NOTIFY /api/v1
NOTIFY /api/v1
OPTIONS /api/v1
OPTIONS /api/v1
PATCH /api/v1
PATCH /api/v1
POST /api/v1
POST /api/v1
PROPFIND /api/v1
PROPFIND /api/v1
PROPPATCH /api/v1
PROPPATCH /api/v1
PURGE /api/v1
PURGE /api/v1
PUT /api/v1
PUT /api/v1
QUERY /api/v1
QUERY /api/v1
REBIND /api/v1
REBIND /api/v1
REPORT /api/v1
REPORT /api/v1
/api/v1
/api/v1
SOURCE /api/v1
SOURCE /api/v1
/api/v1
/api/v1
TRACE /api/v1
TRACE /api/v1
UNBIND /api/v1
UNBIND /api/v1
/api/v1
/api/v1
UNLOCK /api/v1
UNLOCK /api/v1
UNSUBSCRIBE /api/v1
UNSUBSCRIBE /api/v1
staff
GET /api/v1/staff/deliveries
GET /api/v1/staff/deliveries/:id
track
GET /api/v1/track/:token
wallet
GET /api/v1/wallet
GET /api/v1/wallet/transactions
webhooks
POST /api/v1/webhooks/payments/flutterwave
POST /api/v1/webhooks/payments/paystack

Generated per request by src/common/api-index-page.ts · checks run against PostgreSQL and Redis every time this page is loaded.