CSP API Reference
Complete API documentation for CSP - Commerce 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/cspAPI Categories
Invitation
3 endpoints available
- POST Invite a user -
/v1/csp/invitation/:as - DELETE Cancel invitation -
/v1/csp/invitation - POST Accept invitation -
/v1/csp/invitation/accept
Users
3 endpoints available
- GET Fetch all CSP Users -
/v1/csp/users - GET Retreive CSP user account -
/v1/csp/users/:uid - DELETE Remove CSP User -
/v1/csp/users/:uid
Operators
4 endpoints available
- GET Get CSP's Operator Information -
/v1/csp/operators/:id - GET Get All CSP's Operators -
/v1/csp/operators - PATCH Update CSP's Operator Information -
/v1/csp/operators/:id - DELETE Remove Operator Access to CSP -
/v1/csp/operators/:id
Orders
4 endpoints available
- GET Fetch orders -
/v1/rsps/:icode/orders - GET Get order details -
/v1/lsps/:icode/orders/:reference - POST Assign/Unassign order to agent -
/v1/lsps/:icode/orders/:reference/:action/:to - 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/csp/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.

