Orders Overview API

These read-only endpoints expose the same operational views Zendera’s dispatch screens are built on — useful when you want Zendera data on your own wallboard or control-tower dashboard.

Where this fits in your operation

• Backlog monitoring: show the count and list of on-hold orders (imported but not yet planned/dispatchable today) on your operations dashboard, and alert when it grows.
• Day-of-operations wallboard: gantt totals (completed vs late stops) per day, drill into one driver’s timeline, or plot drivers’ live GPS positions and routes on your own map.

Interactive API Explorer

Authentication

Authorization: apikey YOUR_API_KEY_HERE

Base URLs

• Production: https://app.zenderatms.com/api/
• Staging: https://staging.zenderatms.com/api/

On-hold orders (v1)

GET /v1/overview/orders?search=acme&page=1&loads=Customer,OrderLocations
GET /v1/overview/orders/count

The set is fixed: orders with on-hold status whose earliest delivery is before tomorrow — the dispatcher’s “needs attention” backlog. search matches business name, serial code, and order location name. The list response is { "pages", "total", "page", "items": [...] } with full order objects; count returns a bare integer.

Workday views (v2)

GET /v2/overview/gantt?startDate=2026-06-15&endDate=2026-06-15
GET /v2/overview/timeline?workdayID=991
GET /v2/overview/timeline_by_date?driverInternalID=DRV-042&startDate=2026-06-15
GET /v2/overview/map?startDate=2026-06-15&endDate=2026-06-15

• gantt — per-day totals across all drivers: total_driver_stops, completed_driver_stops (and pickup/delivery splits), late_driver_stops, total_orders, plus per-driver rows.
• timeline — one workday in detail: the driver’s identity, vehicles, capacities, and every stop with its completion status.
• timeline_by_date — same view addressed by your driverInternalID and a date range (at least one of startDate/endDate required).
• map — keyed by workday ID: each driver’s live GPS position (latitude/longitude/speed/direction, gps_updated_at), their stops with coordinates, and route geometry (routeGeom) for drawing on a map.

Dates are YYYY-MM-DD, interpreted in your organization’s timezone.

Common gotchas

• The v1 on-hold set is not parameterizable — no date or status filters; it is exactly the dispatch backlog. For general order queries use the Order Summary API.
• Mixed casing: v1 responses are snake_case order objects; v2 uses snake_case fields with a couple of exceptions (routeGeom) — check the explorer.
• GPS is last-known. Check gps_updated_at before treating a position as live.

Related documentation

• Order Summary — order-level queries and the status feed
• Drivers — the workdays these views are built on