Get Routes - Nayax Developer Portal

Get Routes

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/routes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://qa-lynx.nayax.com/operational/v1/Scheduling/routes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/Scheduling/routes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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
      }
    ]
  }
]

Get Routes

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/routes \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://qa-lynx.nayax.com/operational/v1/Scheduling/routes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/Scheduling/routes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/Scheduling/routes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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 Bearer token. 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.

Show child attributes