LSP API Reference
Complete API documentation for LSP - Logistic Service Provider.
Quick Start
Authentication
Choose authentication based on your use case:
User-Connected Apps (De.auth):
http
de-auth-token: YOUR_AUTH_TOKEN
de-user-agent: YOUR_USER_AGENT
de-auth-device: YOUR_DEVICE_IDServer-to-Server / Connectors:
http
Authorization: Bearer <ACCESS_TOKEN>Base URL
https://api.dedot.io/v1/lspAPI Categories
Network Infrastructure
Manage your logistics network:
- Fleet Management - Vehicles, maintenance, parking facilities
- Carriers - Carrier network, capabilities, coverage
- Hubs & Sortation - Distribution hubs, cross-dock operations
- Warehouses - Storage facilities, inventory management
- Terminals - Freight terminals, intermodal operations
Invitation
3 endpoints available
- POST Invite user to LSP workspace -
/v1/lsp/invitation/:as - DELETE Cancel invitation -
/v1/lsp/invitation - POST Accept invitation -
/v1/lsp/invitation/accept
Users
3 endpoints available
- GET Fetch all LSP Users -
/v1/lsp/users - GET Retreive LSP user account -
/v1/lsp/users/:uid - DELETE Remove LSP User -
/v1/lsp/users/:uid
Operators
4 endpoints available
- GET Get LSP's Operator Information -
/v1/lsp/operators/:id - GET Get All LSP's Operators -
/v1/lsp/operators - PATCH Update LSP's Operator Information -
/v1/lsp/operators/:id - DELETE Remove Operator Access to LSP -
/v1/lsp/operators/:id
Agents
6 endpoints available
- GET Get All LSP's agents -
/v1/lsp/agents - GET Get LSP's agent Information -
/v1/lsp/agents/:id?verbose=1 - PATCH Update LSP's agent information -
/v1/lsp/agents/:id - PUT Assign vehicle to LSP Agent -
/v1/lsp/agents/:id/vehicle/assign - PATCH Unassign vehicle from LSP Agent -
/v1/lsp/agents/:id/vehicle/unassign
Pricing
16 endpoints available
- POST Add pricing rule -
/v1/lsp/pricing/rules - GET Get pricing rule -
/v1/lsp/pricing/rules/:id - GET Get all pricing rules -
/v1/lsp/pricing/rules - PATCH Update pricing rule -
/v1/lsp/pricing/rules/:id - DELETE Delete pricing rule -
/v1/lsp/pricing/rules/:id
Coverage
15 endpoints available
- POST Add coverage area segment -
/v1/lsp/coverage/areas/:type - GET Get coverage area -
/v1/lsp/coverage/areas/:id - GET Get all coverage areas -
/v1/lsp/coverage/areas - PATCH Update coverage area -
/v1/lsp/coverage/areas/:id/:type - PUT Link coverage area to a network node -
/v1/lsp/coverage/areas/:id/link
Buckets
10 endpoints available
- POST Create Bucket -
/v1/lsp/buckets/create - GET Retreive bucket -
/v1/lsp/buckets/:reference - GET Get All buckets -
/v1/lsp/buckets - PATCH Update a Bucket Information -
/v1/lsp/buckets/:reference - PATCH Assign/Unassign bucket -
/v1/lsp/buckets/:reference/:action/:type
FAQs
10 endpoints available
- POST Add FAQ -
/v1/lsp/faqs - GET Retrieve FAQ -
/v1/lsp/faqs/:reference - GET Fetch FAQs -
/v1/lsp/faqs - GET Search FAQ -
/v1/lsp/faqs/search?query=delivery - PATCH Update FAQ -
/v1/lsp/faqs/:reference
Orders
4 endpoints available
- GET Fetch orders -
/v1/lsps/:icode/orders - GET Get order details -
/v1/lsps/:icode/orders/:reference - POST Assign/Unassign order to agent -
/v1/lsps/:icode/orders/:reference/:action - GET Cancel order -
/v1/lsps/:icode/orders/:reference/cancel
Response Format
All API responses follow this structure:
typescript
interface APIResponse<T> {
error: boolean;
status: string;
message?: string;
data?: T;
}Success Response
json
{
"error": false,
"status": "SUCCESS",
"data": { ... }
}Error Response
json
{
"error": true,
"status": "ERROR_CODE",
"message": "Human-readable error message"
}Common Error Codes
| Status Code | Description |
|---|---|
SUCCESS | Request completed successfully |
NOT_FOUND | Resource not found (404) |
UNAUTHORIZED | Authentication failed (401) |
FORBIDDEN | Insufficient permissions (403) |
VALIDATION_ERROR | Invalid request data (400) |
INTERNAL_ERROR | Server error (500) |
Rate Limits
Standard Rate Limits:
- 1000 requests per hour
- 100 requests per minute (burst)
Rate limit headers:
http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200When rate limit is exceeded, you'll receive a 429 Too Many Requests response.
Pagination
List endpoints support pagination:
http
GET /v1/lsp/resource?page=1&limit=50Response includes pagination metadata:
json
{
"error": false,
"status": "SUCCESS",
"data": [...],
"pagination": {
"page": 1,
"limit": 50,
"total": 237,
"pages": 5
}
}Helpful Resources
Need help? Check our Developer Portal or contact support.

