Preview

Appointment requests

External systems can submit appointment or service requests to Ordinavo in a structured way and track their status.

Endpoints

POST/connect/v1/appointment-requests
GET/connect/v1/appointment-requests/{id}
GET/connect/v1/appointment-requests/{id}/status
POST/connect/v1/appointment-requests/{id}/cancel

Data model: AppointmentRequest

FieldDescription
externalReferenceExternal reference from the source system.
serviceTypeType of request, for example maintenance, visit, pickup or inspection.
priorityPriority of the request.
customerCustomer, organization or requesting location.
contactContact person for questions or appointment coordination.
locationJob location.
preferredTimeWindowsPreferred time windows.
descriptionDescription of the request.
metadataAdditional technical or business information from the source system.

Status model

Submitted Validated PendingReview Accepted Rejected Scheduled Assigned InProgress Completed Cancelled Failed

Cancellation

POST /connect/v1/appointment-requests/{id}/cancel
Authorization: Bearer {access_token}
Content-Type: application/json
Idempotency-Key: 85f1ac0e-d641-47f4-99c2-0e04af2a1c19
{
  "reason": "Customer requested cancellation",
  "cancelledBy": "external_system"
}
{
  "id": "apr_01JZ7YQ1H7MP6Q5V8N9D4G3A2B",
  "status": "Cancelled",
  "cancelledAt": "2026-06-15T15:12:00Z"
}