> ## Documentation Index
> Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Visit Orders

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



## OpenAPI

````yaml /openapi/lynx.yaml get /v1/Scheduling/schedule/visit-order
openapi: 3.0.1
info:
  title: Nayax Operational Lynx API
  version: v1
servers:
  - url: https://qa-lynx.nayax.com/operational
security:
  - Authorization: []
paths:
  /v1/Scheduling/schedule/visit-order:
    get:
      tags:
        - Scheduling
      summary: Get Visit Orders
      description: >-
        Retrieves a list of visit orders based on various query parameters such
        as VisitDate, MachineId, DriverId, RouteId, and ActorId.
      operationId: get-visit-orders
      parameters:
        - name: VisitDate
          in: query
          description: The date for which the visit orders are requested.
          schema:
            type: string
            format: date-time
        - name: MachineId
          in: query
          description: >-
            The unique identifier of the machine associated with the visit
            order.
          schema:
            type: integer
            format: int64
        - name: DriverId
          in: query
          description: The unique identifier of the driver associated with the visit order.
          schema:
            type: string
            format: uuid
        - name: RouteId
          in: query
          description: The unique identifier of the route associated with the visit order.
          schema:
            type: integer
            format: int64
        - name: ActorId
          in: query
          description: The unique identifier of the actor associated with the visit order.
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: A list of visit orders that match the specified criteria.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VisitOrderResponseDto'
components:
  schemas:
    VisitOrderResponseDto:
      type: object
      properties:
        MachineVisitOrderId:
          type: integer
          format: int64
          description: >-
            The unique identifier for the visit order associated with a specific
            machine.
        VisitDate:
          type: string
          format: date-time
          description: The date and time when the visit is scheduled to occur.
        DriverId:
          type: string
          format: uuid
          nullable: true
          description: >-
            The unique identifier of the driver assigned to the visit. This
            field is nullable if no driver is assigned.
        Machines:
          type: array
          items:
            $ref: '#/components/schemas/MachineOrderResponseDto'
          nullable: true
          description: >-
            A list of machines included in the visit order, each with details
            about the machine's ID, route, and order in the visit sequence.
      additionalProperties: false
    MachineOrderResponseDto:
      type: object
      properties:
        MachineId:
          type: integer
          format: int64
          nullable: true
          description: >-
            The unique identifier of the machine to be visited. This field is
            nullable if the machine ID is not available.
        RouteId:
          type: integer
          format: int64
          nullable: true
          description: >-
            The unique identifier of the route associated with the machine. This
            field is nullable if the route ID is not available.
        OrderKey:
          type: integer
          format: int32
          nullable: true
          description: >-
            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.
      additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Enter your Bearer token. It's required to authenticate API requests.

````