Skip to main content
DealerTeam

Auto-lead Data Format (ADF)

Auto-lead Data Format

 

Auto-lead Data Format or ADF, is an open standard that allows the interchange of information between consumers, dealerships and service providers. The DealerTeam platform accepts new inbound leads that can be routed into the system by constructing an email payload consisting of XML/ADF.  

The structured format for XML/ADF is provided below in two examples, Buy with Trade-in and Sell Only.

MUDD Advertising created a free tool to generate blank ADF templates. Click here to practice and easily produce 100% valid XML in Auto-Lead Data Format. 

 

ADF lead handler in DealerTeam

 

Inbound leads with a properly formatted XML/ADF payload are sent to an unique email handler created for each instance of DealerTeam.

The data from the ADF payload will get used to create a new Sales Up. If a duplicate is detected, the existing Sales Up will get a Traffic Log entry related to the existing record.

helpNote_icon.gifTo setup a new ADF lead handler or to learn more about email addresses related to your instance, contact your success manager or write the DealerTeam help desk, help@dealerteam.com  

 

When the payload is processed the <Provider> tag will translate to the Source field on the Sales Up. The value of <Provider> will get populated "as submitted," regardless of whether that value is available in the Source picklist.

 

Intercompany Lead Routing

 

When ADF messages are received they get processed according to the rules defined in the IntercompanyLeadRouting Custom Setting. To find this custom setting go to Setup and type 'custom setting' in the quick find. Select Custom Settings and then click Manage next to IntercompanyLeadRouting.

Based upon the values in this setting, each email address will assign attributes to the Sales Ups, including Company Number / Location and Lead Type.

  • The Company Number must match the Company Number field on a Location record or the creation will fail.
  • The Lead Type for all inbound ADF messages will default to "Email" unless specified otherwise.

 

ADF Field Mapping

Fields from the inbound ADF will get mapped into a new Sales Up unless an exact match is found with an existing Sales Up within the timeframe outlined in the CRM Settings. If an exact match is encountered a closed activity will get added to the existing Sales Up indicating an additional lead form was submitted. For inbound ADF that does not match to an existing Sales Up the following mapping will be used to create the new Sales Up

 

Vehicle Element

<vehicle interest="buy | lease"> <vehicle interest="sell | trade-in">
  status = dealer__NUO__c   status = n/a
  <year> = dealer__Year_High__c   <year> = dealer__Trade_Year__c
  <make> = dealer__Make__c   <make> = dealer__Trade_Make__c
  <model> = dealer__Model__c   <model> = dealer__Trade_Model__c
  <vin> = dealer__VIN__c   <vin> = dealer__Trade_VIN__c
  <trim> = dealer__Trim__c   <trim> = dealer__Trade_Trim_Level__c
  <transmission> = dealer__Transmission__c   <odometer> = dealer__Trade_Mileage__c
  <stock> = dealer__Desired_Stock_Num__c 
and if there is a matching stock number then also dealer__Vehicle_Inventory__c
  <comments> = dealer__Trade_Comments__c
<vehicle interest="buy | lease"> <finance>        
  <method> = dealer__Finance_Method__c        
  <amount type="monthly"> = dealer__Desired_Monthly_Payment__c      
  <amount type="total"> = dealer__Pre_qualified_Loan_Amount__c      
  <amount type="downpayment"> = dealer__Down_Payment__c      
<vehicle interest="buy | lease"> <colorcombination>        
  <exteriorcolor> = dealer__Color_Preference_Ext__c        
  <interiorcolor> = dealer__Color_Preference_Int__c        
 

Customer Element

<customer> <contact> <customer> <address>  
  <name part="first"> = dealer__FirstName__c   <street> = customerAddressLine1
  <name part="last"> = dealer__LastName__c   <city> = customerCity
  <email> = dealer__Email__c   <regioncode> = customerState
  <phone type="voice | nopreference | null"> = dealer__Phone__c   <postalcode> = customerZip
  <phone type="cellphone"> = dealer__Mobile__c NOTE: address fields get recorded on the Contact/Customer not the Sales Up
<customer> <comments> = dealer__Comments__c   
<customer> <timeframe> = dealer__Timeframe__c       
 

Provider Element

<provider>      
  <name> = dealer__Source__c    
  <service> = dealer__Lead_Origination_Service__c    
 

Record Type

 

If a new lead is submitted and it includes only a single vehicle which is set with an interest of "sell" then the resulting Sales Up will be of record type Curb Purchase. In any other situation, the Sales Up will have a Standard record type.

 

Example XML/ADF

 

Below and attached to this article are ADF payload samples usable for reference or testing.

Valid XML/ADF payloads must begin with a XML Open Tag, "<?xml" (please note lowercase).  By default the content in the XML is UTF-8, however UTF-16 can be specified.   Data may be wrapped in CDATA tags if necessary.

Developers should ensure that they follow XML standards closely which includes lower case xml designation and no white space (including line breaks) beginning the email payload.

 

Buy with Trade-in Sample

 

The Following snippet includes a sample ADF payload for the use case of a customer who wants to purchase a vehicle and trade-in their existing vehicle. Included are both color and finance preferences.

<?xml version="1.0"?>
<?adf version="1.0"?>
<adf>
        <prospect>
                <requestdate>{!NOW()}</requestdate>
                <vehicle interest="trade-in">
                        <year>2013</year>
                        <make>Chrysler</make>
                        <model>Town and Country</model>
                        <trim>Limited</trim>
                        <vin>2C4RC1GG0DR511663</vin>
                        <odometer>36561</odometer>
                        <comments>Test Buy with Trade comments.</comments>
                </vehicle>
                <vehicle interest="buy" status="used">
                        <year>2014</year>
                        <make>Ford</make>
                        <model>Explorer</model>
                        <trim>XLT</trim>
                        <vin>1FM5K8D81EGC25486</vin>
                        <transmission>6-Speed Shiftable Automatic</transmission>
                        <stock>1EGC25486</stock>
                        <colorcombination>
                                <exteriorcolor>black</exteriorcolor>
                                <interiorcolor>gray</interiorcolor>
                        </colorcombination>
                        <finance>
                                <method>finance</method>
                                <amount type="monthly">400</amount>
                                <amount type="total">35000</amount>
                                <amount type="downpayment">2500</amount>
                        </finance>
                </vehicle>
                <customer>
                        <contact>
                                <name part="first">TradeBuyFirst</name>
                                <name part="last">TradeBuyLast</name>
                                <email>tradeBuy@adftest.com</email>
                                <phone type="voice">666-777-8888</phone>
                                <phone type="cellphone">555-666-7777</phone>
                        </contact>
                        <comments>Contact comments test of ADF parser on Buy with Trade sample</comments>
                </customer>
                <provider>
                        <name part="full">ElectraMotors.com</name>
                        <service>ElectraMotors</service>
                </provider>
        </prospect>
</adf>

 

Sell Only Sample

 

This sample will produce a Sales Up with a Curb Purchase record type.

<?xml version="1.0"?>
<?adf version="1.0"?>
<adf>
        <prospect>
                <requestdate>{!NOW()}</requestdate>
                <vehicle interest="sell">
                        <year>2013</year>
                        <make>Chrysler</make>
                        <model>Town and Country</model>
                        <trim>Limited</trim>
                        <vin>2C4RC1GG1DR534336</vin>
                        <odometer>39078</odometer>
                        <comments>Test sell only comments.</comments>
                </vehicle>
                <customer>
                        <contact>
                                <name part="first">SellOnlyFirst</name>
                                <name part="last">SellOnlyLast</name>
                                <email>sellOnly@adftest.com</email>
                                <phone type="voice">888-777-6666</phone>
                                <phone type="cellphone">777-666-5555</phone>
                        </contact>
                        <comments>Contact comments test of ADF parser on Sell Only sample</comments>
                </customer>
                <provider>
                        <name part="full">ElectraMotors.com</name>
                        <service>ElectraMotors</service>
                </provider>
        </prospect>
</adf>