Skip to main content
GET
/
v1
/
Scheduling
/
schedule
/
visit-order
Get Visit Orders
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order \
  --header 'Authorization: <api-key>'
[
  {
    "MachineVisitOrderId": 123,
    "VisitDate": "2023-11-07T05:31:56Z",
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Machines": [
      {
        "MachineId": 123,
        "RouteId": 123,
        "OrderKey": 123
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
VisitDate
string<date-time>

The date for which the visit orders are requested.

​
MachineId
integer<int64>

The unique identifier of the machine associated with the visit order.

​
DriverId
string<uuid>

The unique identifier of the driver associated with the visit order.

​
RouteId
integer<int64>

The unique identifier of the route associated with the visit order.

​
ActorId
integer<int64>

The unique identifier of the actor associated with the visit order.

Response

200 - application/json

A list of visit orders that match the specified criteria.

​
MachineVisitOrderId
integer<int64>

The unique identifier for the visit order associated with a specific machine.

​
VisitDate
string<date-time>

The date and time when the visit is scheduled to occur.

​
DriverId
string<uuid> | null

The unique identifier of the driver assigned to the visit. This field is nullable if no driver is assigned.

​
Machines
object[] | null

A list of machines included in the visit order, each with details about the machine's ID, route, and order in the visit sequence.