This API is used to get all the merchant's agents/drivers/fleets information with respect to a location. The response array contains a status key for each of the fleet, which shows the current status of the fleet - 0 for available, 1 for offline and 2 for busy, taking into account the location, connectivity, ON-Duty/OFF-Duty status and if they are presently working a task.
Request Body Parameters:
Name | Type | Description |
---|---|---|
api_key | string | You can get a key from settings(Login>Menu>Settings>API Keys) in your tookan account. Or click here to get API key |
merchant_id | number | You can get it from account details page in Tookan dashboard.This is the unique ID given to each merchant. Enter the ID of the merchant whose details you want to edit. You can get it from dashboard Menu>More>Merchant. |
team_id | number | You can pass the team_id, if you want to filter the list of agents via team |
tags | string(optional) | You can pass the tags, comma separated, if you want to filter the list of agents via tags. |
fleet_id | number (optional) | You can pass on the fleet_id to get the data of a single fleet. |
latitude | number (optional) | You can pass lat long values to get the distance between agent location and this location pointed by the lat long values.. |
longitude | number (optional) | Both lat long values are required if you want distance measurement and/or enable geo-fence filtering of the agents. |