How to get appointments by order UUID

This document explains how to fetch the appointment (or appointments) linked to a repair order using the order UUID.

How to get appointments by order UUID

Use this endpoint to fetch appointments linked to a specific repair order (RO). You get the repair order UUID from the orders API; this returns all service appointments associated with that order.

You need API credentials to call this endpoint. If you don't have them, see the Authentication and Authorization page to request credentials.

For errors and warnings that this endpoint can return, see Get appointments by order UUID — Errors and warnings.

What you need

Parameter	How to get it
departmentUuid	Provided at the time of integration.
orderUuid	Repair order UUID from Get a list of orders.

Request

HTTP request

GET https://api.mykaarma.com/appointment/v2/dealerDepartment/{departmentUuid}/order/{orderUuid}

Path parameters

Parameter	Type	Description	Required
departmentUuid	String	Unique identifier of dealer's department	Yes
orderUuid	String	Unique identifier of the repair order in myKaarma	Yes

Authorization

Scope	Level	Description
appointment.get	Department	Authorises client to get appointments for the department

Example

curl -X GET "https://api.mykaarma.com/appointment/v2/dealerDepartment/{{departmentUuid}}/order/{{orderUuid}}" \
  -H "accept: application/json" \
  -H "Authorization: {{basic_auth_token}}"

Response

Returns a list of service appointments (serviceAppointments) linked to the given repair order. Each item includes customer, vehicle, order info, assigned advisor, date/time, transport option, services, and related fields. Top-level error and warnings arrays are present when applicable.

{
  "error": [
    {
      "errorCode": 0,
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningDescription": "string"
    }
  ],
  "serviceAppointments": [
    {
      "uuid": "string",
      "customerInformation": {
        "firstName": "string",
        "lastName": "string",
        "company": "string",
        "isBusiness": false,
        "customerKey": "string",
        "confirmationPhone": "string",
        "confirmationEmail": "string",
        "custLocale": "string",
        "uuid": "string"
      },
      "vehicleInformation": {
        "vin": "string",
        "vehicleKey": "string",
        "model": "string",
        "year": "string",
        "brand": "string",
        "trim": "string",
        "engine": "string",
        "mileage": "string",
        "dealerUuid": "string",
        "uuid": "string"
      },
      "orderInformation": {
        "uuid": "string",
        "orderNumber": "string",
        "orderDate": "string",
        "orderType": "string"
      },
      "dealerUuid": "string",
      "assignedAdvisorUuid": "string",
      "creatorAdvisorUuid": "string",
      "assignedAdvisorUserUuid": "string",
      "creatorAdvisorUserUuid": "string",
      "assignedAdvisorDmsDepartmentCode": 0,
      "date": "string",
      "preferredDate": "string",
      "startTime": "string",
      "endTime": "string",
      "transportOption": {
        "uuid": "string",
        "altTransportation": "string",
        "bookingId": "string",
        "bookInThirdParty": false,
        "bookingStartDate": "string",
        "bookingEndDate": "string",
        "bookingIsManual": "string",
        "bookingIsValid": "string",
        "loanerSmartLink": "string",
        "transportation": "string",
        "organicTransportation": "string",
        "subTransportOptionUuid": "string"
      },
      "appointmentKey": "string",
      "mileageText": "string",
      "recall": false,
      "platform": "string",
      "appointmentSource": "string",
      "newStatus": "string",
      "comments": "string",
      "internalNotes": "string",
      "isCancelled": false,
      "reminderCount": 0,
      "serviceList": [
        {
          "uuid": "string",
          "opCode": "string",
          "laborOpCode": "string",
          "description": "string",
          "operationType": "string",
          "laborTotal": 0,
          "partsTotal": 0,
          "shopFees": 0,
          "taxes": 0,
          "price": 0,
          "isValid": true,
          "payType": "string",
          "sortOrder": 1,
          "parentOpcodeUuid": "string",
          "menuUuid": "string",
          "recallID": "string",
          "durationInMins": 1,
          "isCustomConcern": false,
          "isDealerAddedLine": false
        }
      ],
      "skillList": [
        {
          "uuid": "string",
          "name": "string",
          "dealerUuid": "string",
          "departmentUuid": "string",
          "operationList": null,
          "isValid": true
        }
      ],
      "appointmentCommunicationPreferences": {
        "emailConfirmation": true,
        "textConfirmation": false,
        "emailReminder": true,
        "textReminder": false,
        "confirmationEmail": "string",
        "confirmationPhoneNumber": "string",
        "notifyCustomer": true,
        "sendCommunicationToDA": true
      },
      "pdrToOpcodes": {},
      "teamUuid": "string",
      "dispatchCode": "string",
      "customerVehicleInspectionId": "string",
      "sarmetaData": {
        "dmsMetaData": {
          "type": "string",
          "title": "string",
          "description": "string",
          "vehicleUuid": "string",
          "dealerAssociateId": "string"
        },
        "appointmentData": {}
      }
    }
  ]
}