Skip to main content
GET
{orders_api_base_url}
/
orders
/
counts
/
{
  "order_counts": {
    "active": 123,
    "completed": 123
  }
}
This endpoint provides a summary count of orders grouped by their status, giving you immediate visibility into order volume and distribution. This is particularly useful for dashboard displays and operational monitoring.
Use this endpoint to quickly assess store workload and monitor business performance without retrieving detailed order data.

​
Query Parameters

​
store_id
string
required
The unique identifier of the store to get order counts for

​
Response

​
order_counts
object
Object containing counts for different order statuses

​
Response Example

{
  "active": 123,
  "completed": 1
}

​
Use Cases

​
Dashboard Widgets

Create real-time dashboard displays showing:
  • Current active order volume
  • Completed orders for the day/period
  • Order processing capacity

​
Performance Monitoring

Track key metrics:
  • Active Orders: Monitor current workload and identify peak times
  • Completed Orders: Measure daily/weekly performance and revenue impact
  • Order Velocity: Calculate completion rates and processing efficiency

​
Staff Management

Use counts to:
  • Determine staffing needs during peak hours
  • Identify when additional help is needed
  • Monitor order processing capacity

​
Business Intelligence

Analyze patterns:
  • Peak order times for scheduling optimization
  • Daily/weekly volume trends
  • Capacity planning for busy periods
Poll this endpoint regularly to create real-time monitoring dashboards that help staff understand current workload and prioritize tasks.
The “active” count includes all orders that require attention or are in progress, while “completed” represents successfully fulfilled orders.
High active order counts may indicate processing bottlenecks or the need for additional staff during peak periods.
⌘I