Skip to main content
POST
/
v1
/
Scheduling
/
routes
Create New Route
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/routes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RouteName": "<string>",
  "RouteCode": "<string>",
  "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "RouteRemarks": "<string>",
  "RouteStatusId": 123
}
'
{
  "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<int32>

The unique identifier of the operator for whom the route is being created.

Body

application/json
​
RouteName
string | null

The name of the route to be created.

​
RouteCode
string | null

The code used to identify the route to be created.

​
DriverId
string<uuid>

The unique identifier of the driver to be assigned to the route.

​
RouteRemarks
string | null

Additional remarks or notes related to the route.

​
RouteStatusId
integer<int32>

The status identifier of the route, indicating its initial status.

Response

200 - application/json

The newly created route details.

​
RouteId
integer<int64>

The unique identifier of the route.

​
DriverId
string<uuid> | null

The unique identifier of the driver assigned to the route.

​
DriverName
string | null

The name of the driver assigned to the route.

​
DriverMobile
string | null

The mobile phone number of the driver assigned to the route.

​
RouteName
string | null

The name of the route.

​
RouteCode
string | null

The code used to identify the route.

​
RouteRemarks
string | null

Additional remarks or notes related to the route.

​
RouteStatusId
integer<int32>

The status identifier of the route, indicating its current status.

​
RouteMachineCount
string | null

The number of machines assigned to the route.

​
CreatedDt
string<date-time>

The date and time when the route was created.

​
CreatedBy
integer<int64>

The identifier of the user who created the route.

​
UpdatedDt
string<date-time> | null

The date and time when the route was last updated.

​
UpdatedBy
integer<int64> | null

The identifier of the user who last updated the route.