---
title: "Get Visit Orders"
method: GET
path: "/v1/Scheduling/schedule/visit-order"
tags: ["Scheduling"]
---

# Get Visit Orders

`GET /v1/Scheduling/schedule/visit-order`

## Request

- Base URL: `https://example.com:443`
- URL: `https://example.com:443/v1/Scheduling/schedule/visit-order`
- Auth: none required
- TypeScript: <https://skmtc.dev/nayax/apis/nayax-cortina-api/docs/v1/Scheduling/schedule/visit-order/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of visit orders based on various query parameters such as VisitDate, MachineId, DriverId, RouteId, and ActorId.

## Query parameters

- `VisitDate` string, date-time
- `MachineId` integer
- `DriverId` string, uuid
- `RouteId` integer
- `ActorId` integer

## Response `200`

A list of visit orders that match the specified criteria.

- VisitOrderResponseDto[]
  - `MachineVisitOrderId` integer: 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, nullable: The unique identifier of the driver assigned to the visit. This field is nullable if no driver is assigned.
  - `Machines` MachineOrderResponseDto[], nullable: A list of machines included in the visit order, each with details about the machine's ID, route, and order in the visit sequence.
    - `MachineId` integer, nullable: The unique identifier of the machine to be visited. This field is nullable if the machine ID is not available.
    - `RouteId` integer, nullable: The unique identifier of the route associated with the machine. This field is nullable if the route ID is not available.
    - `OrderKey` integer, nullable: 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.

---

[API](https://skmtc.dev/nayax/apis/nayax-cortina-api.md) - [All operations](https://skmtc.dev/nayax/apis/nayax-cortina-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nayax/apis/nayax-cortina-api/revisions/421f6f83c257?raw)