Evglo

Add Consignments To Best Route

Adds pending consignments into an already-created routing run for a hub on a given dispatch date (use cases: Rush Delivery, Plan Adhoc Orders, Add To Best Route). Required inputs: hubId, dispatchDate (YYYY-MM-DD). Optional: routingId (AutoRouting.id) — when omitted, tool fetches completed routings for the hub on dispatchDate; if exactly one is found it is auto-selected, if multiple exist status=ROUTE_SELECTION_REQUIRED is returned with the list and the caller must re-invoke with one routingId. O

Get Current User Details

Return profile details of the currently authenticated user. Returns login, firstName, lastName, email, cityId, hubId, merchants, latitude, longitude, endAddress, hubs (list of {hubId, hubName, hubCode}), userType ({id, name}), mobileNumber, serviceProviderCode, timezone, and roles.

Assign Routes

Assign all routes from a completed route optimisation run to their field executives. Given a routingId (from runRouteOptimisation) and a dispatchDate (YYYY-MM-DD), this tool: validates the routing is complete, marks it ready for dispatch, validates assignment with the shipment service, assigns each route to its field executive, and updates route users. Returns status SUCCESS or ERROR with per-route details. Use this after runRouteOptimisation returns a completed routing.

Get Working Drivers

Return all drivers/field-executives in a hub that have a roster entry for a given date. Provide hubId and date (YYYY-MM-DD). Fetches all existing rosters for the hub on that date, collects the rostered user IDs, then returns every hub driver found in those rosters. Response includes drivers list and count.

Run Route Optimisation

Trigger route optimisation for a given hub. Before triggering, validates that enough drivers are rostered for today's pending order volume (SPR=50 orders/driver). Finds the top inactive (disabled) scheduled routing configuration for the hub to pick the optimisation configuration and triggers the optimisation. Managers can only run optimisation for hubs assigned to them; admins can run for any hub. Optional routingDate (YYYY-MM-DD) overrides the scheduled routing's rosterFutureDate for this run o

Get Route Status

Check the current status of a route optimisation by its routing ID. Returns a user-friendly message indicating whether the route is completed, currently running, waiting in the queue, cancelled, or encountered an error. Managers can only check routes for hubs assigned to them; admins can check any hub.

Find Hub By Name

Find hubs by name using fuzzy match. Returns hubId, hubName, and hubCode for all matching hubs in the current company. Use this to look up a hub ID before creating rosters.

Find User By Username

Find active users by login username using fuzzy match. Returns userId, login, firstName, lastName, and employeeCode for matching users in the current company. Use this to look up a user ID before creating rosters.

Find Geo Fence By Name

Search for geofences within a specific hub by partial or full name. Returns fenceId, name, hubId, fenceType, and priority for all enabled, non-virtual (fenceType!=5) matching fences. Non-admin callers are restricted to hubs assigned to them. Use findHubByName first if you need to resolve a hub ID.

Check Driver Availability

Checks driver availability for a given hub and date. Contacts drivers via the specified mode ('email' or 'call'), tracks confirmations via Kafka, and retries if a driver declines or communication fails; returns immediately with requestId and runs in the background until the required count is met or the timeout is reached. Required inputs: chatSessionId (unique per request), requiredDriverCount, hubId, date (YYYY-MM-DD). Optional: mode ('email' or 'call', default 'email'), timeoutMinutes (default

Get Driver Availability Status

Check the current status of a previously initiated driver availability request. Given the chatSessionId used when the check was initiated via 'Check Driver Availability', returns the current status (IN_PROGRESS, COMPLETED, TIMEOUT), confirmed driver count, required driver count, and the list of driver codes that have confirmed so far. Returns status NOT_FOUND if no request exists for the given chatSessionId, or DENIED if the caller does not have access to the request's hub.

Get Add To Best Route Status

Returns execution status of an add-to-best-route / rush-delivery / adhoc routing run by routingId (AutoRouting.id). Reports total requested, success, failed, pending counts plus failure reasons (parsed from auto_routing tables). Use this to poll completion after addConsignmentsToBestRoute returns status=TRIGGERED.