Skip to main content

Dashboard Summary

curl -X GET "http://localhost:8080/api/v1/reports/dashboard-summary" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get high-level summary metrics for the dashboard.

Response

data
object

Roles

Accessible by: admin, manager, cashier

Sales Reports

curl -X GET "http://localhost:8080/api/v1/reports/sales?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get aggregated sales data grouped by date within a specified range.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of daily sales summaries

Roles

Accessible by: admin, manager, cashier

Product Performance

curl -X GET "http://localhost:8080/api/v1/reports/products?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get sales performance metrics for each product.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of product performance data

Roles

Accessible by: admin, manager, cashier

Payment Method Performance

curl -X GET "http://localhost:8080/api/v1/reports/payment-methods?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get usage counts and totals for each payment method.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of payment method performance data

Roles

Accessible by: admin, manager, cashier

Cashier Performance

curl -X GET "http://localhost:8080/api/v1/reports/cashier-performance?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get order counts and sales totals handled by each cashier.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of cashier performance data

Roles

Accessible by: admin, manager, cashier

Cancellation Reports

curl -X GET "http://localhost:8080/api/v1/reports/cancellations?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get statistics on order cancellations grouped by reason.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of cancellation statistics

Roles

Accessible by: admin, manager, cashier

Profit Summary

curl -X GET "http://localhost:8080/api/v1/reports/profit-summary?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get gross profit analytics grouped by date.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of daily profit summaries

Roles

Accessible by: admin, manager, cashier

Product Profit Reports

curl -X GET "http://localhost:8080/api/v1/reports/profit-products?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_TOKEN"
Get profitability metrics for each product sold.

Query Parameters

start_date
string
required
Start date in YYYY-MM-DD format
end_date
string
required
End date in YYYY-MM-DD format

Response

data
array
Array of product profit data

Roles

Accessible by: admin, manager, cashier

Build docs developers (and LLMs) love