API Overview

July 17, 2026 · View on GitHub

The Logistics API is a RESTful service built with ASP.NET Core.

Base URL

Environment	URL
Development	https://localhost:7000
Production	https://api.yourdomain.com

Swagger Documentation

Interactive API documentation is available at:

Development: https://localhost:7000/swagger
Production: https://api.yourdomain.com/swagger (if enabled)

Authentication

All API endpoints (except health checks) require authentication via JWT Bearer tokens.

GET /api/loads HTTP/1.1
Host: api.yourdomain.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

See Authentication for details on obtaining tokens.

Response Format

Success Response

{
  "isSuccess": true,
  "data": { ... },
  "error": null
}

Error Response

{
  "isSuccess": false,
  "data": null,
  "error": "Error message describing what went wrong"
}

Paginated Response

{
  "isSuccess": true,
  "data": {
    "items": [ ... ],
    "totalItems": 100,
    "totalPages": 10,
    "currentPage": 1,
    "pageSize": 10
  }
}

API Endpoints

Core Resources

Resource	Endpoint	Description
Loads	`/api/loads`	Shipment management
Trips	`/api/trips`	Trip tracking
Customers	`/api/customers`	Customer management
Employees	`/api/employees`	Employee records
Drivers	`/api/drivers`	Driver-specific data
Trucks	`/api/trucks`	Fleet management
Invoices	`/api/invoices`	Billing
Payments	`/api/payments`	Payment processing

Administrative

Resource	Endpoint	Description
Users	`/api/users`	User management
Roles	`/api/roles`	Role management
Tenants	`/api/tenants`	Tenant management
Subscriptions	`/api/subscriptions`	Billing plans

Messaging

Resource	Endpoint	Description
Conversations	`/api/messages/conversations`	Get/create conversations
Messages	`/api/messages`	Send and receive messages
Unread Count	`/api/messages/unread-count`	Get unread message count

Inspections

Resource	Endpoint	Description
Inspections	`/api/inspections`	Cargo condition reports (list/get/create)
Inspection Parts	`/api/inspections/parts?loadType=...`	Per-cargo-type part catalog used to classify defects
VIN Decoder	`/api/vins/{vin}`	Decode VIN to vehicle info

Documents

Resource	Endpoint	Description
Documents	`/api/documents`	File management
Proof of Delivery	`/api/documents/pod`	Capture POD with photos/signature
Bill of Lading	`/api/documents/bol`	Capture BOL documents

Utilities

Resource	Endpoint	Description
Notifications	`/api/notifications`	Push notifications
Reports	`/api/reports`	Report generation
Stats	`/api/stats`	Analytics data

Common Query Parameters

Pagination

GET /api/loads?page=1&pageSize=20

Sorting

GET /api/loads?orderBy=createdDate&descending=true

Filtering

GET /api/loads?status=active&customerId=123

Search

GET /api/loads?search=container

HTTP Status Codes

Code	Meaning
200	Success
201	Created
400	Bad Request (validation error)
401	Unauthorized (no/invalid token)
403	Forbidden (insufficient permissions)
404	Not Found
500	Internal Server Error

The API applies a global fixed-window limiter of 100 requests/minute, partitioned by authenticated user (falling back to the Host header). Stricter named policies apply to specific surfaces (impersonation, login, mcp). Exceeded limits return 429. Full table in Architecture overview → Rate limiting.

Webhooks

Stripe webhooks are received at:

POST /webhooks/stripe

See Stripe Webhooks for configuration, and Webhook conventions for signature validation and idempotency.

Real-Time (SignalR)

For real-time features, connect to SignalR hubs:

GPS Tracking: /hubs/tracking
Notifications: /hubs/notification
Chat: /hubs/chat
AI Dispatch: /hubs/ai-dispatch

See SignalR Hubs for details.

API Client Generation

The Angular apps generate their API client from OpenAPI:

cd src/Client/Logistics.Angular
bun run gen:api

This creates TypeScript types and services matching the API in the shared library.

Next Steps

Authentication - OAuth2 flow
Endpoints - Detailed endpoint reference
SignalR Hubs - Real-time features