Appointment API

📄️ Appointment data model

This is the data structure that you will receive every time you are trying to get appointments from our APIs or listening to our events.

📄️ How to get appointments in myKaarma

This document is designed to help you understand how you can get appointments made in the myKaarma system. Let's get started.

📄️ How to create an appointment

This document is designed to help you understand how to create an appointment in myKaarma, what all parameters would you need, how to fetch them and then use them to best suit your use case.

📄️ How to update an appointment

You can update appointments in myKaarma for customer visits so that your Service Advisors are aware of the changed schedule and your customers could be notified/reminded for their scheduled visit.

📄️ How to cancel an appointment

To cancel an appointment, you can simply use the same endpoint that is used to update an appointment. The only parameter that needs to be passed is 'status' with the value "CANCELLED". Please check the example below.

📄️ How to create a draft Appointment

Create a sample draft appointment and generate a short URL for consumer scheduler with pre-filled information.

📄️ How to get an appointment by appointment UUID

Use this endpoint to fetch a single appointment by its unique identifier (UUID). Use it when you already have the appointment UUID—for example from a create/update response or from another list endpoint (by date, customer, or order).

📄️ How to get appointments by appointment date

This document is designed to help you fetch appointments scheduled on a particular date depending on your use case.

📄️ 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 for a customer

This document is designed to help you fetch appointments for a customer depending on your use case.

📄️ How to get appointments by filter

This document is designed to help you fetch appointments using filter. This may be helpful in cases where you need to fetch appointments for:

📄️ How to save an opcode

Use this endpoint to create a new labor opcode (operation code) for a dealer department, or to update an existing one. Opcodes define services that can be attached to appointments (e.g. oil change, tire rotation).

📄️ How to get eligible Advisor for a dealer

Get service advisor list for which appointment can be scheduled in myKaarma

📄️ How to get TransportOption for a Dealer

Get all transport options for dealer. The response from this API can be cached as transport options rarely change.

📄️ How to get resource availabilities

Get the availabilities of advisors, transport options and teams as per the selected attributes including opcodes, recalls, customer and their chosen vehicle for the specified dates.

📄️ How to get the first available slot

Get the first available slot to schedule appointments as per the selected attributes including advisor, transport option, team, opcodes, recalls, customer and their chosen vehicle.

📄️ How to get BrandYear for a Dealer

Get Brand Year for the provided Dealer UUID

📄️ How to get vacant slot info with rules

This endpoint is deprecated. Please migrate to the updated endpoint getResourceAvailability (/department//availability) by 31st July 2025.

📄️ How to get trips for an appointment

This document explains how to fetch pickup and delivery (PnD) trips linked to an appointment. This is useful when you want to view the trip details associated with a specific service appointment.

📄️ How to create an appointment with trip

This document explains how to create an appointment along with a pickup and delivery (PnD) trip in a single API call. This is useful when you want to schedule a service appointment and simultaneously set up a pickup/delivery trip for the customer's vehicle.

📄️ How to create a partner appointment with trip

This document explains how to create an appointment along with a pickup and delivery (PnD) trip in a single API call using the Partner v2 endpoint. You can also create a linked dropoff vehicle trip in the same request by adding dropTripInformation. This endpoint provides a simplified, consolidated contract compared to the standard appointment-with-trip endpoint — trip and appointment details are merged into one flat request rather than two separate nested objects.

📄️ How to update an appointment with trip

This document explains how to update an existing appointment along with its associated pickup and delivery (PnD) trip in a single API call. This is useful when you need to modify both the appointment details and the trip details simultaneously.

📄️ How to delete an appointment with trip

This document explains how to delete an appointment along with its associated pickup and delivery (PnD) trip in a single API call. This is useful when you need to cancel both the appointment and the trip simultaneously.

📄️ How to update a partner appointment with trip

This document explains how to update an existing appointment and its pickup/dropoff trips using the Partner v2 endpoint.

📄️ How to get partner trips for an appointment

This document explains how to fetch the pickup and linked dropoff trips for a partner appointment created through the Partner v2 appointment-with-trip endpoint.

📄️ Appointment API — Endpoints, Errors and Warnings Reference

This document lists each Appointment API endpoint and the error codes and warning codes that may be returned in API responses. Use it to handle errors and warnings in your integration.

📄️ API Reference

📄️ How to delete a partner appointment with trip

This document explains how to delete a partner appointment and its linked pickup/dropoff trips using the Partner v2 delete endpoint.