This page describes planned API endpoints for the Syngenta Warehouse Management System. The application is currently in early development. No API endpoints are currently implemented.
Overview
The Reports API will provide endpoints for generating various analytics and reports related to inventory, orders, warehouse operations, and performance metrics.
Get Inventory Report
Generate a comprehensive inventory report with stock levels, movements, and analytics.
Endpoint
GET /api/v1/reports/inventory
Query Parameters
Filter by product category
Filter by status: active, low_stock, out_of_stock, discontinued
Report start date (ISO 8601)
Report end date (ISO 8601)
Report format: json, csv, pdf
Request Example
curl -X GET "https://api.syngenta-wms.com/api/v1/reports/inventory?warehouse=WH001&format=json" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Total number of inventory items
Total quantity across all items
Number of items below reorder point
Number of out of stock items
Inventory breakdown by categoryNumber of items in category
Total quantity in category
Inventory breakdown by warehouseNumber of items in warehouse
Total quantity in warehouse
Total quantity added during period
Total quantity removed during period
Total adjustments during period
Report generation timestamp (ISO 8601)
{
"success": true,
"data": {
"summary": {
"totalItems": 1247,
"totalValue": 15678450.00,
"totalQuantity": 2456789,
"activeItems": 1180,
"lowStockItems": 45,
"outOfStockItems": 22
},
"byCategory": [
{
"category": "seeds",
"itemCount": 456,
"totalQuantity": 1234567,
"totalValue": 8900000.00
},
{
"category": "pesticides",
"itemCount": 389,
"totalQuantity": 567890,
"totalValue": 4200000.00
},
{
"category": "fertilizers",
"itemCount": 402,
"totalQuantity": 654332,
"totalValue": 2578450.00
}
],
"byWarehouse": [
{
"warehouse": "WH001",
"itemCount": 847,
"totalQuantity": 1876543,
"totalValue": 12345000.00
},
{
"warehouse": "WH002",
"itemCount": 400,
"totalQuantity": 580246,
"totalValue": 3333450.00
}
],
"movements": {
"additions": 456789,
"removals": 234567,
"adjustments": 12345
},
"generatedAt": "2026-03-12T10:30:00Z"
},
"metadata": {
"timestamp": "2026-03-12T10:30:00Z",
"requestId": "req_report1"
}
}
When format is set to csv or pdf, the response will be a downloadable file instead of JSON.
Get Orders Report
Generate a comprehensive report on order fulfillment and performance.
Endpoint
GET /api/v1/reports/orders
Query Parameters
Report start date (ISO 8601)
Report end date (ISO 8601)
Group results by: day, week, month
Report format: json, csv, pdf
Request Example
curl -X GET "https://api.syngenta-wms.com/api/v1/reports/orders?startDate=2026-03-01&endDate=2026-03-12&groupBy=day" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Total revenue from orders
Average time to process (hours)
Average time to ship (hours)
Average time to deliver (hours)
Percentage of on-time deliveries
Orders grouped by time periodTime period (date or date range)
Number of orders in period
Average order value in period
Most ordered productsNumber of orders containing this product
Revenue from this product
Report generation timestamp (ISO 8601)
{
"success": true,
"data": {
"summary": {
"totalOrders": 342,
"totalRevenue": 4567890.50,
"averageOrderValue": 13356.42,
"ordersByStatus": {
"pending": 45,
"processing": 78,
"shipped": 123,
"delivered": 89,
"cancelled": 7
},
"fulfillmentMetrics": {
"averageProcessingTime": 8.5,
"averageShippingTime": 48.2,
"averageDeliveryTime": 72.8,
"onTimeDeliveryRate": 94.5
}
},
"timeSeries": [
{
"period": "2026-03-01",
"orderCount": 28,
"revenue": 356789.00,
"averageOrderValue": 12742.46
},
{
"period": "2026-03-02",
"orderCount": 31,
"revenue": 412345.50,
"averageOrderValue": 13301.47
}
],
"topProducts": [
{
"inventoryId": "inv_123456",
"sku": "SYN-SEED-001",
"name": "NK603 Corn Seed",
"orderCount": 156,
"totalQuantity": 234567,
"revenue": 1993819.50
},
{
"inventoryId": "inv_123457",
"sku": "SYN-FERT-002",
"name": "Atrazine 4L Herbicide",
"orderCount": 134,
"totalQuantity": 89456,
"revenue": 1140564.00
}
],
"generatedAt": "2026-03-12T10:30:00Z"
},
"metadata": {
"timestamp": "2026-03-12T10:30:00Z",
"requestId": "req_report2"
}
}
Endpoint
GET /api/v1/reports/warehouse-performance
Query Parameters
Filter by warehouse code (omit for all warehouses)
Report start date (ISO 8601)
Report end date (ISO 8601)
Report format: json, csv, pdf
Request Example
curl -X GET "https://api.syngenta-wms.com/api/v1/reports/warehouse-performance?startDate=2026-03-01&endDate=2026-03-12" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Array of warehouse performance metricsStorage utilization percentage
Average pick time (minutes)
Average pack time (minutes)
Average ship time (minutes)
Order accuracy percentage
On-time shipment percentage
{
"success": true,
"data": [
{
"warehouse": {
"code": "WH001",
"name": "Central Distribution Center",
"location": "Des Moines, IA"
},
"inventory": {
"totalItems": 847,
"totalValue": 12345000.00,
"utilizationRate": 78.5,
"turnoverRate": 4.2
},
"orders": {
"totalOrders": 256,
"ordersShipped": 198,
"ordersDelivered": 167,
"ordersCancelled": 5
},
"performance": {
"averagePickTime": 12.5,
"averagePackTime": 8.3,
"averageShipTime": 4.7,
"accuracyRate": 98.2,
"onTimeShipmentRate": 95.7
},
"issues": {
"damagedItems": 7,
"incorrectOrders": 3,
"delayedShipments": 11
}
},
{
"warehouse": {
"code": "WH002",
"name": "West Coast Hub",
"location": "Sacramento, CA"
},
"inventory": {
"totalItems": 400,
"totalValue": 3333450.00,
"utilizationRate": 65.3,
"turnoverRate": 3.8
},
"orders": {
"totalOrders": 86,
"ordersShipped": 67,
"ordersDelivered": 54,
"ordersCancelled": 2
},
"performance": {
"averagePickTime": 14.2,
"averagePackTime": 9.1,
"averageShipTime": 5.3,
"accuracyRate": 96.8,
"onTimeShipmentRate": 92.4
},
"issues": {
"damagedItems": 4,
"incorrectOrders": 2,
"delayedShipments": 6
}
}
],
"metadata": {
"timestamp": "2026-03-12T10:30:00Z",
"requestId": "req_report3"
}
}
Get Low Stock Alert Report
Generate a report of items below their reorder point.
Endpoint
GET /api/v1/reports/low-stock
Query Parameters
Filter by product category
Custom threshold percentage (e.g., 50 for 50% of reorder point)
Report format: json, csv, pdf
Request Example
curl -X GET "https://api.syngenta-wms.com/api/v1/reports/low-stock?warehouse=WH001" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
Returns a list of inventory items below their reorder point with recommended reorder quantities.
Items marked as critical (less than 25% of reorder point) require immediate attention.
Export Report
Export any report in CSV or PDF format.
Endpoint
GET /api/v1/reports/{reportType}
?format=csv or ?format=pdf to any report endpoint to download the report in the specified format.
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="inventory-report-2026-03-12.csv"
Content-Type: application/pdf
Content-Disposition: attachment; filename="inventory-report-2026-03-12.pdf"
CSV and PDF exports are limited to 10,000 records. For larger datasets, use pagination with JSON format.
Error Responses
Invalid Date Range
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "End date must be after start date",
"details": {
"startDate": "2026-03-12",
"endDate": "2026-03-01"
}
},
"metadata": {
"timestamp": "2026-03-12T10:30:00Z",
"requestId": "req_error1"
}
}
Date Range Too Large
{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Date range cannot exceed 90 days",
"details": {
"maxDays": 90,
"requestedDays": 120
}
},
"metadata": {
"timestamp": "2026-03-12T10:30:00Z",
"requestId": "req_error2"
}
}
