API Overview

API Overview

The SmartWMS API provides programmatic access to all platform features, enabling integration with your existing systems.

Base URL

https://api.smartwms.one/api/v1

API Features

• RESTful Design: Standard HTTP methods
• JSON Format: Request and response bodies
• Versioned: API versioning for stability
• Rate Limited: Fair usage limits
• Authenticated: Secure token-based auth

Available Resources

Request Format

curl -X GET "https://api.smartwms.one/api/v1/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Format

All responses follow this structure:

{
  "success": true,
  "data": { ... },
  "message": null,
  "errors": null
}

Error Response:

{
  "success": false,
  "data": null,
  "message": "Validation failed",
  "errors": ["SKU is required", "Name is required"]
}

HTTP Status Codes

Pagination

List endpoints support pagination:

GET /api/v1/products?page=1&pageSize=50

Response includes:

{
  "data": {
    "items": [...],
    "totalCount": 1234,
    "page": 1,
    "pageSize": 50,
    "totalPages": 25
  }
}

Rate Limits

Rate limit headers:

• X-RateLimit-Limit: Max requests
• X-RateLimit-Remaining: Remaining
• X-RateLimit-Reset: Reset timestamp

SDK Libraries

Official SDKs available:

• JavaScript/TypeScript
• Python
• C#/.NET
• PHP

See GitHub for SDK documentation.