CDK Drive Customer (Preview)

Reference

The API will allow you to find, retrieve, and filter service customers in CDK Drive. Within CDK Drive, a customer is an individual who has been sold a vehicle, is a prospect on a vehicle, has bought parts, or has had their vehicle repaired or serviced through the dealership and exists in a CRM system. In addition, this connector will allow you to create a basic customer record. This helps service advisers provide a positive experience by allowing those workflows to be tied to a customer.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	CDK Global
URL	https://serviceconnect.support.cdk.com
Email	[email protected]

Connector Metadata
Publisher	CDK Global
Website	https://fortellis.io
Privacy policy	https://fortellis.io/privacy
Categories	Data

ABOUT

The CDKDrive Customer API V1 allows you to search, view, create, and update customer records in CDK Drive.

https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9

Key Concepts

Customers

A customer is an individual in the CDK Drive DMS who meets at least one of the following criteria:

Purchased a vehicle (or is a prospect to purchase a vehicle) from the dealership
Purchased parts from the dealership
Brought a vehicle into the dealership for repairs or service

Potential Use Cases

Use the CDKDrive Customer API to create solutions to handle situations such as:

Search for a customer and display customer details
Create or update customer information
Update a customer's preferred contact methods
Get customer information to link with vehicles with the CDKDrive Service Vehicles API

The CDKDrive Customer API can be used independently or with any of the following APIs.

DEALS

Find and create a deal using information about the customer and vehicle they are purchasing or leasing. The CDKDrive Customer API can be used to associate customer records with deals. Deals API: Get dealership employees.

https://apidocs-dev.fortellis.io/specs/91145f3f-2dd7-43fa-a63d-08908ef9e2e7

CDKDRIVE REPAIR ORDERS

Enable service writeup workflows on CDK Drive. The CDKDrive Customer API can be used to associate customer records with repair orders.

https://apidocs.fortellis.io/specs/b0f20c99-ed1f-49de-a0e8-6776d2ee0fe3

CDKDRIVE SERVICE VEHICLES

Create, update, query, and retrieve service domain vehicle information in CDK Drive. You can link customers to vehicles using the CDKDrive Service Vehicles API.

https://apidocs.fortellis.io/specs/54b70ee1-ac17-4be2-9314-45c947692c5d

GETTING STARTED WITH THE CDKDRIVE CUSTOMER API

Pre-requisites

You will need the following to proceed

• To use the connector, you need to be a Fortellis user.

• You need to create an solution in Fortellis to generate client id and secret to be used while calling the APIs

Detailed Documentation can be found at

https://apidocs.fortellis.io/specs/0d488dd1-c609-4618-9061-68be8b61c2a9

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a customer	Create a customer
Query a customer	Query a customer
Query customers	Query customers
Update a customer	Update a customer

Create a customer

Operation ID:: createCustomer

Create a customer

Parameters

Name	Key	Required	Type	Description
Client Id	client_id	True	string	A client ID that should be unique to developer/solution provider building the solution.
Client Secret	client_secret	True	string	A client secret that should be unique to developer/solution provider building the solution.
Subscription Id	subscription_id	True	string	A correlation ID that should be returned back to the caller to indicate the return of the given request.
Request Id	Request-Id		string	Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request
first	first	True	string	The first name of the customer
middle	middle		string	The middle name of the customer
last	last	True	string	The last name of the customer
prefix	prefix		string	The prefix of the customer
suffix	suffix		string	The suffix of the customer
primaryPhone	primaryPhone		string	The primary phone number of the customer
homePhone	homePhone		string	The home phone number of the customer
mobilePhone	mobilePhone		string	The mobile phone number of the customer
pager	pager		string	The pager number of the customer
pagerAccessCode	pagerAccessCode		string	The pager access code of the customer
homeFax	homeFax		string	The home fax number of the customer
workFax	workFax		string	The work fax number of the customer
email1	email1		string	Email address 1 of the customer. You can enter NA for Non-Applicable or CD for Customer Declined if no other email address is present
emailDesc1	emailDesc1		string	Email address 1 description. Will contain NA or CD if entered on email1.
email2	email2		string	Email address 2 of the customer
emailDesc2	emailDesc2		string	Email address 2 description
email3	email3		string	Email address 3 of the customer
emailDesc3	emailDesc3		string	Email address 3 description
email4	email4		string	Email address 4 of the customer
emailDesc4	emailDesc4		string	Email address 4 description
email5	email5		string	Email address 5 of the customer
emailDesc5	emailDesc5		string	Email address 5 description
email6	email6		string	Email address 6 of the customer
emailDesc6	emailDesc6		string	Email address 6 description
preferredMethod	preferredMethod		string	The preferred method of contact for the customer
blockPhoneFlag	blockPhoneFlag		boolean	Indicates whether or not to phone telephone advertising
blockEmailFlag	blockEmailFlag		boolean	Indicates whether or not to block e-mail advertising
blockMailFlag	blockMailFlag		boolean	Indicates whether or not to block mail advertising
street	street		string	Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.
city	city		string	Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.
county	county		string	Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.
state	state		string	A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
postalCode	postalCode		string	Postal code. Usually country-wide, but sometimes specific to the city (e.g. '2' in 'Dublin 2, Ireland' addresses).
country	country		string	The ISO country code of the country

Returns

Body: Customer

Query a customer

Operation ID:: queryCustomerById

Query a customer

Parameters

Name	Key	Required	Type	Description
Customer Id	customerId	True	string	The customer identifier
Subscription Id	subscription_id	True	string	A correlation ID that should be returned back to the caller to indicate the return of the given request.
Client Id	client_id	True	string	A client ID that should be unique to developer/solution provider building the solution.
Client Secret	client_secret	True	string	A client secret that should be unique to developer/solution provider building the solution.
Request Id	Request-Id		string	Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Body: Customer

Query customers

Operation ID:: queryCustomers

Query customers

Parameters

Name	Key	Required	Type	Description
Name	name		string	Filters customers by name
Email	email		string	Filters customers by email address
Phone	phone		string	Filters customers by phone number
Subscription Id	subscription_id	True	string	A correlation ID that should be returned back to the caller to indicate the return of the given request.
Client Id	client_id	True	string	A client ID that should be unique to developer/solution provider building the solution.
Client Secret	client_secret	True	string	A client secret that should be unique to developer/solution provider building the solution.
Request Id	Request-Id		string	Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Body: CustomerCollection

Update a customer

Operation ID:: updateCustomer

Update a customer

Parameters

Name	Key	Required	Type	Description
Customer Id	customerId	True	string	The customer identifier
Subscription Id	subscription_id	True	string	A correlation ID that should be returned back to the caller to indicate the return of the given request.
Client Id	client_id	True	string	A client ID that should be unique to developer/solution provider building the solution.
Client Secret	client_secret	True	string	A client secret that should be unique to developer/solution provider building the solution.
Request Id	Request-Id		string	Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request
eTag	If-Match	True	string	Makes the resource update request conditional. The checksum value presented with If-Match must match the current ETag value of the resource.
first	first	True	string	The first name of the customer
middle	middle		string	The middle name of the customer
last	last	True	string	The last name of the customer
prefix	prefix		string	The prefix of the customer
suffix	suffix		string	The suffix of the customer
primaryPhone	primaryPhone		string	The primary phone number of the customer
homePhone	homePhone		string	The home phone number of the customer
mobilePhone	mobilePhone		string	The mobile phone number of the customer
pager	pager		string	The pager number of the customer
pagerAccessCode	pagerAccessCode		string	The pager access code of the customer
homeFax	homeFax		string	The home fax number of the customer
workFax	workFax		string	The work fax number of the customer
email1	email1		string	Email address 1 of the customer. You can enter NA for Non-Applicable or CD for Customer Declined if no other email address is present
emailDesc1	emailDesc1		string	Email address 1 description. Will contain NA or CD if entered on email1.
email2	email2		string	Email address 2 of the customer
emailDesc2	emailDesc2		string	Email address 2 description
email3	email3		string	Email address 3 of the customer
emailDesc3	emailDesc3		string	Email address 3 description
email4	email4		string	Email address 4 of the customer
emailDesc4	emailDesc4		string	Email address 4 description
email5	email5		string	Email address 5 of the customer
emailDesc5	emailDesc5		string	Email address 5 description
email6	email6		string	Email address 6 of the customer
emailDesc6	emailDesc6		string	Email address 6 description
preferredMethod	preferredMethod		string	The preferred method of contact for the customer
blockPhoneFlag	blockPhoneFlag		boolean	Indicates whether or not to phone telephone advertising
blockEmailFlag	blockEmailFlag		boolean	Indicates whether or not to block e-mail advertising
blockMailFlag	blockMailFlag		boolean	Indicates whether or not to block mail advertising
street	street		string	Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.
city	city		string	Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.
county	county		string	Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.
state	state		string	A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
postalCode	postalCode		string	Postal code. Usually country-wide, but sometimes specific to the city (e.g. '2' in 'Dublin 2, Ireland' addresses).
country	country		string	The ISO country code of the country

Returns

Body: Customer

Definitions

Customer

Name	Path	Type	Description
customerId	customerId	string	The identifier of the customer record
name	name	Name
contactMethods	contactMethods	ContactMethods
postalAddress	postalAddress	PostalAddress
preferredContact	preferredContact	string	The preferred contact method
links	links	CustomerLinks

ContactMethods

Name	Path	Type	Description
primaryPhone	primaryPhone	string	The primary phone number of the customer
homePhone	homePhone	string	The home phone number of the customer
mobilePhone	mobilePhone	string	The mobile phone number of the customer
pager	pager	string	The pager number of the customer
pagerAccessCode	pagerAccessCode	string	The pager access code of the customer
homeFax	homeFax	string	The home fax number of the customer
workFax	workFax	string	The work fax number of the customer
email1	email1	string	Email address 1 of the customer. You can enter NA for Non-Applicable or CD for Customer Declined if no other email address is present
emailDesc1	emailDesc1	string	Email address 1 description. Will contain NA or CD if entered on email1.
email2	email2	string	Email address 2 of the customer
emailDesc2	emailDesc2	string	Email address 2 description
email3	email3	string	Email address 3 of the customer
emailDesc3	emailDesc3	string	Email address 3 description
email4	email4	string	Email address 4 of the customer
emailDesc4	emailDesc4	string	Email address 4 description
email5	email5	string	Email address 5 of the customer
emailDesc5	emailDesc5	string	Email address 5 description
email6	email6	string	Email address 6 of the customer
emailDesc6	emailDesc6	string	Email address 6 description
preferredMethod	preferredMethod	string	The preferred method of contact for the customer
blockPhoneFlag	blockPhoneFlag	boolean	Indicates whether or not to phone telephone advertising
blockEmailFlag	blockEmailFlag	boolean	Indicates whether or not to block e-mail advertising
blockMailFlag	blockMailFlag	boolean	Indicates whether or not to block mail advertising

PostalAddress

Name	Path	Type	Description
street	street	string	Can be street, avenue, road, etc. This element also includes the house number and room/apartment/flat/floor number.
city	city	string	Can be city, village, town, borough, etc. This is the postal town and not necessarily the place of residence or place of business.
county	county	string	Handles administrative districts such as U.S. or U.K. counties that are not used for mail addressing purposes. Subregion is not intended for delivery addresses.
state	state	string	A state, province, county (in Ireland), Land (in Germany), departement (in France), etc.
postalCode	postalCode	string	Postal code. Usually country-wide, but sometimes specific to the city (e.g. '2' in 'Dublin 2, Ireland' addresses).
country	country	string	The ISO country code of the country

CustomerLinks

Name	Path	Type	Description
Details of a link to a resource	self	LinkDescriptionObject

CustomerCollection

Name	Path	Type	Description
items	items	array of Customer

Name

Name	Path	Type	Description
first	first	string	The first name of the customer
middle	middle	string	The middle name of the customer
last	last	string	The last name of the customer
prefix	prefix	string	The prefix of the customer
suffix	suffix	string	The suffix of the customer
companyName	companyName	string	If the customer represents a company, then company name will be considered

LinkDescriptionObject

Name	Path	Type	Description
href	href	string	The target URI
method	method	string	The HTTP verb that MUST be used to make a request to the target of the link
title	title	string	The title property provides a title for the link and is a helpful documentation tool to facilitate understanding by end clients

Поделиться через

CDK Drive Customer (Preview)

ABOUT

Key Concepts

Customers

Potential Use Cases

DEALS

CDKDRIVE REPAIR ORDERS

CDKDRIVE SERVICE VEHICLES

GETTING STARTED WITH THE CDKDRIVE CUSTOMER API

Pre-requisites

Detailed Documentation can be found at

Throttling Limits

Actions

Create a customer

Parameters

Returns

Query a customer

Parameters

Returns

Query customers

Parameters

Returns

Update a customer

Parameters

Returns

Definitions

Customer

ContactMethods

PostalAddress

CustomerLinks

CustomerCollection

Name

LinkDescriptionObject

Дополнительные ресурсы

Поделиться через

CDK Drive Customer (Preview)

ABOUT

Key Concepts

Customers

Potential Use Cases

Related APIs

DEALS

CDKDRIVE REPAIR ORDERS

CDKDRIVE SERVICE VEHICLES

GETTING STARTED WITH THE CDKDRIVE CUSTOMER API

Pre-requisites

Detailed Documentation can be found at

Throttling Limits

Actions

Create a customer

Parameters

Returns

Query a customer

Parameters

Returns

Query customers

Parameters

Returns

Update a customer

Parameters

Returns

Definitions

Customer

ContactMethods

PostalAddress

CustomerLinks

CustomerCollection

Name

LinkDescriptionObject

Дополнительные ресурсы