Elead Product Reference Data (Preview)

This API provides data to be used in conjunction with other eLeads APIs as needed. API searches, retrieves and provides the following details - Opportunity sources and sub sources for a specified company and up types, opportunity statuses for a specified company, sales steps for a specified company, employee positions for a specified company, employees by company and position, sender email addresses for a specified company, available vehicle class, year, make, model, trim.

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
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Contact
Name CDK Global
URL https://serviceconnect.support.cdk.com
Email mbd_support@cdk.com
Connector Metadata
Publisher CDK Global
Website https://fortellis.io
Privacy policy https://fortellis.io/privacy
Categories Data

What does this API do?

This helper API provides data to be used in conjunction with other APIs as needed.

Intended Audience

This API is for dealers and vendor partners who need to retrieve Elead product reference data to support other APIs.

Capabilities and Features

This API searches, retrieves and provides the following details to support interaction with other APIs.

  • Opportunity sources for a specified company and up types
  • Opportunity subsources for a specified source and up types
  • Opportunity statuses for a specified company
  • Sales steps for a specified company
  • Employee positions for a specified company
  • Employees by company and position
  • Sender email addresses for a specified company
  • Available vehicle class types
  • Available vehicle year
  • Available vehicle makes by year and vehicle class (optional)
  • Available vehicle models by year and make
  • Available vehicle trims by year, make and model

Pre-requisites

You will need the following to proceed

  • To use the connector, you need to be a Fortellis user
  • You need to create a 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/8bbbe60f-b382-4315-8d19-ba48a64b2ab3

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Gets the "from" email addresses for the specified company

Gets the "from" email addresses for the specified company

Gets the available vehicle class types

Gets the available vehicle class types

Gets the available vehicle makes by year and vehicle class (optional)

Gets the available vehicle makes by year and vehicle class (optional)

Gets the available vehicle models by year and make

Gets the available vehicle models by year and make

Gets the available vehicle trims by year, make, and model

Gets the available vehicle trims by year, make, and model

Gets the available vehicle years

Gets the available vehicle years

Gets the employees for the specified company and position

Gets the employees for the specified company and position

Gets the opportunity sources for the specified company and up types

Gets the opportunity sources for the specified company and up types

Gets the opportunity statuses for the specified company

Gets the opportunity statuses for the specified company

Gets the positions for the specified company

Gets the positions for the specified company

Gets the sales steps for the specified company

Gets the sales steps for the specified company

Retrieves the opportunity subsources for the specified source and up types

Retrieves the opportunity subsources for the specified source and up types

Gets the "from" email addresses for the specified company

Gets the "from" email addresses for the specified company

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the available vehicle class types

Gets the available vehicle class types

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the available vehicle makes by year and vehicle class (optional)

Gets the available vehicle makes by year and vehicle class (optional)

Parameters

Name Key Required Type Description
Year
year True integer

Year of Manufacturing

Class
class string

Class of the vehicle

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the available vehicle models by year and make

Gets the available vehicle models by year and make

Parameters

Name Key Required Type Description
Year
year True integer

Year of Manufacturing

Make
make True string

Make of the Car

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the available vehicle trims by year, make, and model

Gets the available vehicle trims by year, make, and model

Parameters

Name Key Required Type Description
Year
year True integer

Year of Manufacturing

Make
make True string

Make of the Car

Model
model True string

Model of the Car

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the available vehicle years

Gets the available vehicle years

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the employees for the specified company and position

Gets the employees for the specified company and position

Parameters

Name Key Required Type Description
Position Name
positionName True string

The position name

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the opportunity sources for the specified company and up types

Gets the opportunity sources for the specified company and up types

Parameters

Name Key Required Type Description
Up Type
upType string

The opportunity source up type

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the opportunity statuses for the specified company

Gets the opportunity statuses for the specified company

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Gets the positions for the specified company

Gets the positions for the specified company

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Gets the sales steps for the specified company

Gets the sales steps for the specified company

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Retrieves the opportunity subsources for the specified source and up types

Retrieves the opportunity subsources for the specified source and up types

Parameters

Name Key Required Type Description
Source Name
sourceName True string

The source name

Up Type
upType True string

The opportunity source up type

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.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - uuid.

Returns

Definitions

UpType

Opportunity Source UpType

Opportunity Source UpType

LinkDescriptionObject

Name Path Type Description
href
href string

The target URI

rel
rel string

The link relation type

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 that describes the object

CompanyOpportunityStatusCollection

Name Path Type Description
items
items array of CompanyOpportunityStatus

A collection of company opportunity statuses

CompanyOpportunitySourceCollection

Name Path Type Description
items
items array of CompanyOpportunitySource

A collection of company opportunity sources

links
links array of LinkDescriptionObject

A collection of HATEOAS links

CompanyOpportunityStatus

Name Path Type Description
status
status string

Company Opportunity Status Name

subStatuses
subStatuses array of CompanyOpportunitySubStatus

CompanyOpportunitySubStatus

Name Path Type Description
subStatus
subStatus string

Description of the sub status

CompanyOpportunitySource

Name Path Type Description
name
name string

Company Opportunity Source Name

upType
upType UpType

Opportunity Source UpType

isActive
isActive boolean

true/false whether this company opportunity source is active

requestPhrase
requestPhrase string

(Future Use) Request phrase for the specified company opportunity source

requiresSubSource
requiresSubSource boolean

true/false whether this company opportunity source requires a Subsource

hasSubSources
hasSubSources boolean

true/false whether this company opportunity source has subsources (path to retrieve these subsources is in the HATEOAS links collection)

links
links array of LinkDescriptionObject

A collection of HATEOAS links

OpportunitySubSourceCollection

Name Path Type Description
items
items array of OpportunitySubSource

A collection of opportunity subsources

links
links array of LinkDescriptionObject

A collection of HATEOAS links

OpportunitySubSource

Name Path Type Description
name
name string

Opportunity subsource name

isActive
isActive boolean

true/false whether this opportunity subsource is active

CompanySalesStepCollection

Name Path Type Description
items
items array of CompanySalesStep

A collection of company sales steps

links
links array of LinkDescriptionObject

A collection of HATEOAS links

CompanySalesStep

Name Path Type Description
name
name string

Sales step name

abbreviation
abbreviation string

Abbreviation for the sales step name

isActive
isActive boolean

true/false whether this sales step is active

sortOrder
sortOrder integer

Intended order of the sales step if building a drop down in UI

CompanyPositionCollection

Name Path Type Description
items
items array of CompanyPosition

A collection of company positions

links
links array of LinkDescriptionObject

A collection of HATEOAS links

CompanyPosition

Name Path Type Description
name
name string

Position name

code
code string

Position code

hasEmployees
hasEmployees boolean

true/false whether this company position has employees (path to retrieve these employees is in the HATEOAS links collection)

links
links array of LinkDescriptionObject

A collection of HATEOAS links

CompanyEmployeeCollection

Name Path Type Description
items
items array of Employee

A collection of company employees

links
links array of LinkDescriptionObject

A collection of HATEOAS links

Employee

Name Path Type Description
id
id uuid

Employee identifier

firstName
firstName string

Employee first name

lastName
lastName string

Employee last name

isActive
isActive boolean

true/false whether this employee is active within the company

isOff
isOff boolean

true/false whether this employee is currently working and can accept new internet opportunities being processed into the system

links
links array of LinkDescriptionObject

A collection of HATEOAS links

CompanyEmailCollection

Name Path Type Description
items
items array of CompanyEmail

A collection of company "from" email addresses

links
links array of LinkDescriptionObject

A collection of HATEOAS links

CompanyEmail

Name Path Type Description
address
address string

Email address

VehicleClassCollection

Name Path Type Description
items
items array of VehicleClass

A collection of vehicle classes

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleClass

Name Path Type Description
name
name string

Vehicle class name

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleYearCollection

Name Path Type Description
items
items array of VehicleYear

A collection of vehicle years

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleYear

Name Path Type Description
year
year integer

Vehicle year

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleMakeCollection

Name Path Type Description
year
year integer

Vehicle year for this collection of vehicle makes

items
items array of VehicleMake

A collection of vehicle makes

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleMake

Name Path Type Description
name
name string

Vehicle make name

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleModelCollection

Name Path Type Description
year
year integer

Vehicle year for this collection of vehicle models

make
make string

Vehicle make for this collection of vehicle models

items
items array of VehicleModel

A collection of vehicle models

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleModel

Name Path Type Description
name
name string

Vehicle Model Name

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleTrimCollection

Name Path Type Description
year
year integer

Vehicle year for this collection of vehicle trims

make
make string

Vehicle make for this collection of vehicle trims

model
model string

Vehicle model for this collection of vehicle trims

items
items array of VehicleTrim

A collection of vehicle trims

links
links array of LinkDescriptionObject

A collection of HATEOAS links

VehicleTrim

Name Path Type Description
name
name string

Vehicle trim name

links
links array of LinkDescriptionObject

A collection of HATEOAS links