Customers
A comprehensive guide to manage customers and vehicles in myKaarma. Customer is a central entity upon which every other aspect is built—appointments, orders, inspections, and more.
📄️ How to create or update a customer (search for duplicates)
For saving a customer using mykaarma's deduplication logic, this document explains how to create or update a customer without performing a client-side search. This is the recommended approach for appointment creation and most integration workflows. By setting the searchForDuplicate parameter to true in the request body (the default value is false), the system automatically searches for an existing customer using the Customer Matching Logic.
📄️ How to search a customer
This document is designed to help you understand how you can fetch a list of Customers with search parameters customizations. The endpoint enables user to get a list of customers that contains a particular string ({}) in multiple fields({{fieldsToBeSearched}}) like `ID, firstName, communications etc.` and one can control to combine the results from the searchTerm being present in different fieldsToBeSearched by `AND or OR`.
📄️ Customer data model
This is the data structure of Customer entity when you are trying to create or update Customer in myKaarma.
📄️ How to update a customer
This document is designed to help you understand how you can update an existing customer, along with their communications, vehicles and addresses, using a given request body and customer UUID.
📄️ Vehicle data model
This is the data structure of Vehicle entity when you are trying to create or update Vehicle in myKaarma.
📄️ Customer matching logic
This is the Customer matching logic that myKaarma backend follows to make sure we do not create duplicates while saving customers.
📄️ How to read a customer
This document is designed to help you understand how you can read a particular customer. The endpoint enables user to get details of a speicifc customer.
📄️ How to create a customer
This document is designed to help you understand how you can create a customer along with communications, vehicles and addresses with a given request body.
📄️ How to search and create a customer (for partners with search)
For appointment creation and most workflows, use Create or update customer with search for duplicates instead. This document is for partners who have their own search functionality and prefer to search first, then create or update based on results.