Skip to main content
GET
/
v1
/
Scheduling
/
routes
Get Routes
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/routes \
  --header 'Authorization: <api-key>'
[
  {
    "DistributorId": 123,
    "OperatorId": 123,
    "OperatorName": "<string>",
    "ActorRoutes": [
      {
        "RouteId": 123,
        "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "DriverName": "<string>",
        "DriverMobile": "<string>",
        "RouteName": "<string>",
        "RouteCode": "<string>",
        "RouteRemarks": "<string>",
        "RouteStatusId": 123,
        "RouteMachineCount": "<string>",
        "CreatedDt": "2023-11-07T05:31:56Z",
        "CreatedBy": 123,
        "UpdatedDt": "2023-11-07T05:31:56Z",
        "UpdatedBy": 123
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Query Parameters

​
OperatorId
integer<int64>

The unique identifier of the operator associated with the routes.

​
DriverId
string<uuid>

The unique identifier of the driver assigned to the routes.

​
Status
integer<int32>

The status identifier of the routes to filter the results.

​
Search
string

A search string used to find routes based on various fields.

​
SearchByName
boolean
default:false

Indicates whether to search by route name.

​
SearchByCode
boolean
default:false

Indicates whether to search by route code.

​
SearchByNotes
boolean
default:false

Indicates whether to search by route notes.

​
SearchByRouteId
boolean
default:false

Indicates whether to search by route ID.

Response

200 - application/json

A list of routes that match the specified criteria.

​
DistributorId
integer<int64>

The unique identifier of the distributor associated with the routes.

​
OperatorId
integer<int64>

The unique identifier of the operator associated with the routes.

​
OperatorName
string | null

The name of the operator associated with the routes.

​
ActorRoutes
object[] | null

A list of routes associated with the operator and distributor.