Customer API
A comprehensive guide to manage customer in myKaarma. Customer is a central entity upon which every other aspect is built like Appointments, Orders, Inspections etc. This guide can be referred as help in following operations:
📄️ How to get a list of Customers
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`.
📄️ How to create a customer
This document is designed to help you understand how you can create a customer along with vehicles and addresses with a given request body.
📄️ How to update a customer
This document is designed to help you understand how you can update an existing customer, along with their vehicles and addresses, using a given request body and customer UUID.
📄️ 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 search and create a customer
This document is designed to help you understand how you can first search for existing customers in myKaarma to avoid duplicates, and then create a new customer (along with vehicles and addresses) using a given request body.