Skip to main content
POST
/
v1
/
Scheduling
/
schedule
/
visit-order
Create Visit Orders
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/Scheduling/schedule/visit-order \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "MachineId": 123,
    "VisitDate": "2023-11-07T05:31:56Z",
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "RouteId": 123,
    "OrderKey": 123
  }
]
'
[
  {
    "VisitDate": "2023-11-07T05:31:56Z",
    "MachineId": 123,
    "DriverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "RouteId": 123,
    "OrderKey": 123,
    "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.

Body

application/json
​
MachineId
integer<int64>

The unique identifier of the machine for which the visit order is being created.

​
VisitDate
string<date-time>

The date and time when the machine is scheduled to be visited.

​
DriverId
string<uuid> | null

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

​
RouteId
integer<int64> | null

The unique identifier of the route associated with the machine visit. This field is nullable if the route is not specified.

​
OrderKey
integer<int32>

The sequence order key indicating the position of the machine in the visit order.

Response

200 - application/json

The newly created visit orders.

​
VisitDate
string<date-time>

The date and time when the machine is scheduled to be visited.

​
MachineId
integer<int64> | null

The unique identifier of the machine associated with the visit order. This field is nullable if the machine ID is not available.

​
DriverId
string<uuid> | null

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

​
RouteId
integer<int64> | null

The unique identifier of the route associated with the machine visit. This field is nullable if the route is not specified.

​
OrderKey
integer<int32> | null

The sequence order key indicating the position of the machine in the visit order. This field is nullable if the order key is not defined.

​
CreatedDt
string<date-time>

The date and time when the visit order was created.

​
CreatedBy
integer<int64>

The unique identifier of the user who created the visit order.

​
UpdatedDt
string<date-time> | null

The date and time when the visit order was last updated. This field is nullable if no updates have been made.

​
UpdatedBy
integer<int64> | null

The unique identifier of the user who last updated the visit order. This field is nullable if no updates have been made.