Routes

Get service provider ETA

post

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

latitudenumberOptional

Latitude coordinate

Example: 40.7128

longitudenumberOptional

Longitude coordinate

Example: -74.006

startDateTimeone ofRequired

Start date time for which routes should be fetched

Default: 2025-12-15T15:08:19.235ZExample: 2025-12-15T15:08:19.235Z

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofRequired

End date time for which routes should be fetched

Default: 2025-12-15T15:08:19.235ZExample: 2025-12-15T15:08:19.235Z

string · dateOptional

or

string · date-timeOptional

getNearestProvidersbooleanOptional

Flag to get nearest service providers

Example: true

maxNearestProvidersCountnumberOptional

Max number of nearest service providers to fetch

Default: 5Example: 5

considerCurrentAppointmentbooleanOptional

Check if service provider is in the appointment

Default: 3Example: 2

considerServiceProviderAvailabilitybooleanOptional

Only consider service providers who are available at the given time

Default: 3Example: 2

Body

application/json

anyOptional

Responses

200Success

application/json

post

/api/location/service-provider/routes

HTTPcURLJavaScriptPython

POST /api/location/service-provider/routes?startDateTime=2025-12-15T15%3A08%3A19.235Z&endDateTime=2025-12-15T15%3A08%3A19.235Z HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*

200Success

{
  "externalId": "12345",
  "serviceProviderLocation": {
    "address": "123 Main St, New York, NY",
    "addressId": 1,
    "latitude": 40.7128,
    "longitude": -74.006,
    "routes": {
      "distanceMeters": 1000,
      "duration": 10,
      "polyline": {
        "points": "encodedPolyline"
      }
    }
  },
  "patientLocation": {
    "address": "123 Main St, New York, NY",
    "addressId": 1,
    "latitude": 40.7128,
    "longitude": -74.006,
    "routes": {
      "distanceMeters": 1000,
      "duration": 10,
      "polyline": {
        "points": "encodedPolyline"
      }
    }
  },
  "origin": {
    "address": "123 Main St, New York, NY",
    "addressId": 1,
    "latitude": 40.7128,
    "longitude": -74.006,
    "routes": {
      "distanceMeters": 1000,
      "duration": 10,
      "polyline": {
        "points": "encodedPolyline"
      }
    }
  },
  "destinations": {
    "address": "123 Main St, New York, NY",
    "addressId": 1,
    "latitude": 40.7128,
    "longitude": -74.006,
    "routes": {
      "distanceMeters": 1000,
      "duration": 10,
      "polyline": {
        "points": "encodedPolyline"
      }
    }
  },
  "routes": []
}