Modal Auto-lead Data Format (ADF) Version 2.0

Table of Contents

1. Overview
2. CRM quick setup
3. Modal products
4. Summary of <provider> field values
5. Available values In the <service> field
6. Modal transaction types
7. Modal Checkout steps
8. Corresponding <id> and "source" format
9. List of all possible values in the <id> and "source" fields
10. Shift Digital partner integration

Overview

• Lead information is sent to the dealership CRM email address on file with Modal using the Auto-lead Data Format (ADF) XML. 
• Modal leads can be mapped into the CRM for followup and reporting based on the <provider> section of the ADF lead.
• Dealers and their CRM team should reference the values listed in this article to reconfigure their CRM to accommodate the changes.
• Modal currently supports two formats with Version 1.0 becoming deprecated in August 2020,  This document summarizes Version 2.0, which is now the default format.
• If your lead email subject or provider contain "Drive Motors" then you are using Modal's ADF lead version 1.0; Please contact your CSM or support@modalup.com to upgrade to Modal ADF leads version 2.0
• Version 2.0's email subject line will read "New {transaction type} from Modal" where transaction type is one of the values listed below.

CRM quick setup

The dealership CRM can be configured to use the Modal ADF content to trigger the appropriate response flows. A Modal Order represents a customer completing the Modal Checkout process, and they should receive different communication than a customer who has not yet completed the process, in accordance with Modal's training guidelines and the dealership's established practices.

With source as the primary lead identification field

<provider>
    <name part="full">Modal Checkout - save order - review</name>
    <email>sales@drivemotors.com</email>
    <phone type="voice">8662006766</phone>
    <service>Modal Checkout - lead button</service>
    <id source="Modal" sequence="172743">3220</id>
</provider>

OR, with name as the primary lead identification field

<provider>
    <name part="full">Modal</name>
    <email>sales@drivemotors.com</email>
    <phone type="voice">8662006766</phone>
    <service>Modal Checkout - lead button</service>
    <id source="Modal Checkout - save order - review" sequence="172743">3220</id>
</provider>

1. Let Modal know which CRM you work with and whether your CRM parsing is based primarily on the ADF "source" or "name" field.
2. Modal will enable the proper configuration for your dealer so the lead type is declared either in the ADF "source" or "name" field.
3. Order: If the lead type contains "- approved order", "- order", or "- non credit order", the customer finished the Modal Checkout process with the intent to buy or lease a vehicle.
4. Partial Order: If the lead type contains "- save order", "- abandon", or "- message", the customer has not finished the Modal Checkout process.
5. Trade: If the lead type contains "tradein appraisal", the customer estimated their vehicle's value using Modal's Trade module.

Modal products

The products listed below are the primary Modal systems that can trigger a ADF output to a dealer's CRM.  This table can be referenced to understand which Modal product was engaged during the buyer's session.  

Summary of <provider> field values

Lead information will be included within the <provider></provider> XML tags.  This section will have five fields.  The table below summarizes the values Modal will send for each field.

<provider>
    <name part="full">Modal</name>
    <email>sales@drivemotors.com</email>
    <phone type="voice">8662006766</phone>
    <service>Modal Checkout - lead button</service>
    <id source="Modal Checkout - save order - review" sequence="172743">3220</id>
</provider>

source="{product name} - {transaction type} - {from step}"

<service>{product name} - {CTA name}</service>

source="{product name} - {transaction type} - {from step}"

Available values in the <service> field 

The <service> field will only be populated when transaction type is save order, abandon, or message.

Modal transaction types

Modal Checkout steps

A Modal Checkout session is a series of steps that varies based on the dealer settings and the CTA used to start the session.  The last completed step will sometimes but not always be included as part of the source.  The transaction types approved order, order, non credit order, and tradein appraisal are considered complete sessions, and do not include the last step completed.

The example below demonstrates the ordering of steps for the buy button, lead button, or savings button:

checkout start -> trade -> payment -> upgrades -> delivery -> billing info -> approval info -> cobuyer billing info (optional) -> cobuyer approval info (optional) -> credit decisions -> review

The example below demonstrates the ordering of steps for the tradein button:

trade -> payment -> upgrades -> delivery -> billing info -> approval info -> cobuyer billing info (optional) -> cobuyer approval info (optional) -> credit decisions -> review

The example below demonstrates the ordering of steps for the payment button:

payment modal -> checkout start -> trade -> payment -> upgrades -> delivery -> billing info -> approval info -> cobuyer billing info (optional) -> cobuyer approval info (optional) -> credit decisions -> review

Corresponding <id> and "source"/"name" format

The ADF <provider><id> value is a 4 digit code that maps 1:1 with the human-readable source or name value, and describes the Modal product used, the Modal transaction type, and the last completed step of the Checkout session.

Proprietary Id value format

{1-digit Product Name Code} {1-digit Transaction Type Code} {2-digit Last Step Code}

{1-digit Product Name Code} {1-digit Transaction Type Code} {2-digit Last Step Code}

{1-digit Product Name Code} {1-digit Transaction Type Code} {2-digit Last Step Code}

List of all possible values in the <id> and "source"/"name" fields

This list summarizes the set of values that Modal can send.  CRM administrators can use this list to configure the correct follow up behavior within a CRM.

*Bold items below represent leads where the user completed the Checkout or Trade session with the intent to buy, lease, or trade a vehicle. Other items represent abandons, messages, saved orders where the user did not yet complete their session.

** If your CRM uses name as the primary lead parsing differentiation field, you will find the lead types in the name field, and source will simply be "Modal"

<id source="Modal Checkout - approved order">1095</id>
<id source="Modal Checkout - order">1092</id>
<id source="Modal Checkout - non credit order">1090</id>
<id source="Modal Trade - tradein appraisal">4025</id>
<id source="Modal Dashboard - deal shared to customer">2500</id>
<id source="Modal Checkout - abandon">1100</id>
<id source="Modal Checkout - abandon - payment modal">1107</id>
<id source="Modal Checkout - abandon - upgrades">1110</id>
<id source="Modal Checkout - abandon - trade">1120</id>
<id source="Modal Checkout - abandon - delivery">1130</id>
<id source="Modal Checkout - abandon - payment">1140</id>
<id source="Modal Checkout - abandon - billing info">1150</id>
<id source="Modal Checkout - abandon - cobuyer billing info">1155</id>
<id source="Modal Checkout - abandon - approval info">1160</id>
<id source="Modal Checkout - abandon - cobuyer approval info">1165</id>
<id source="Modal Checkout - abandon - credit decisions">1170</id>
<id source="Modal Checkout - abandon - review">1180</id>
<id source="Modal Checkout - save order">1200</id>
<id source="Modal Checkout - save order - upgrades">1210</id>
<id source="Modal Checkout - save order - trade">1220</id>
<id source="Modal Checkout - save order - delivery">1230</id>
<id source="Modal Checkout - save order - payment">1240</id>
<id source="Modal Checkout - save order - billing info">1250</id>
<id source="Modal Checkout - save order - cobuyer billing info">1255</id>
<id source="Modal Checkout - save order - approval info">1260</id>
<id source="Modal Checkout - save order - cobuyer approval info">1265</id>
<id source="Modal Checkout - save order - credit decisions">1270</id>
<id source="Modal Checkout - save order - review">1280</id>
<id source="Modal Checkout - message">1300</id>
<id source="Modal Checkout - message - upgrades">1310</id>
<id source="Modal Checkout - message - trade">1320</id>
<id source="Modal Checkout - message - delivery">1330</id>
<id source="Modal Checkout - message - payment">1340</id>
<id source="Modal Checkout - message - billing info">1350</id>
<id source="Modal Checkout - message - cobuyer billing info">1355</id>
<id source="Modal Checkout - message - approval info">1360</id>
<id source="Modal Checkout - message - cobuyer approval info">1365</id>
<id source="Modal Checkout - message - credit decisions">1370</id>
<id source="Modal Checkout - message - review">1380</id>
<id source="Modal Shop - tradein appraisal">3025</id>
<id source="Modal Shop - approved order">3095</id>
<id source="Modal Shop - order">3092</id>
<id source="Modal Shop - non credit order">3090</id>
<id source="Modal Shop - abandon">3100</id>
<id source="Modal Shop - abandon - payment modal">3107</id>
<id source="Modal Shop - abandon - upgrades">3110</id>
<id source="Modal Shop - abandon - trade">3120</id>
<id source="Modal Shop - abandon - delivery">3130</id>
<id source="Modal Shop - abandon - payment">3140</id>
<id source="Modal Shop - abandon - billing info">3150</id>
<id source="Modal Shop - abandon - cobuyer billing info">3155</id>
<id source="Modal Shop - abandon - approval info">3160</id>
<id source="Modal Shop - abandon - cobuyer approval info">3165</id>
<id source="Modal Shop - abandon - credit decisions">3170</id>
<id source="Modal Shop - abandon - review">3180</id>
<id source="Modal Shop - save order">3200</id>
<id source="Modal Shop - save order - upgrades">3210</id>
<id source="Modal Shop - save order - trade">3220</id>
<id source="Modal Shop - save order - delivery">3230</id>
<id source="Modal Shop - save order - payment">3240</id>
<id source="Modal Shop - save order - billing info">3250</id>
<id source="Modal Shop - save order - cobuyer billing info">3255</id>
<id source="Modal Shop - save order - approval info">3260</id>
<id source="Modal Shop - save order - cobuyer approval info">3265</id>
<id source="Modal Shop - save order - credit decisions">3270</id>
<id source="Modal Shop - save order - review">3280</id>
<id source="Modal Shop - message">3300</id>
<id source="Modal Shop - message - upgrades">3310</id>
<id source="Modal Shop - message - trade">3320</id>
<id source="Modal Shop - message - delivery">3330</id>
<id source="Modal Shop - message - payment">3340</id>
<id source="Modal Shop - message - billing info">3350</id>
<id source="Modal Shop - message - cobuyer billing info">3355</id>
<id source="Modal Shop - message - approval info">3360</id>
<id source="Modal Shop - message - cobuyer approval info">3365</id>
<id source="Modal Shop - message - credit decisions">3370</id>
<id source="Modal Shop - message - review">3380

Shift Digital partner integration

Documentation Changelog

• 1.0 / July 1, 2020: Initial draft release.
• 1.1 / July 16, 2020: Reformatted text and tables.
• 1.2 / July 17, 2020: General language updates and improvements.  Updated document flow.
• 1.3 / July 31, 2020: Adding Shift Digital section.
• 1.4 / Dec 31, 2020: Adjust default checkout step ordering and add 'checkout start' step
• 1.5 / Feb 12, 2021: Add 'Create a deal' lead info