Implementer Documentation
Using Suite Query Strings or URL Parameters
Suite QueryStrings or URL parameters can be used to change how Suite initializes. Some of these parameters are required and others are optional depending on the workflows you have chosen. By defining various parameters, you can change a variety of things from the dimensions of the Suite app to which vehicle is in scope by vin or even a general description to even custom vehicle images and logging information.
The URL parameters defined for the workflows below are valid whether or not the TradeDriver Plug-in is also participating in the workflow. Browse the type of workflow your organization is implementing to learn about its URL parameters.
These URL parameters will either follow the base Suite URL if deep-linking to Suite or be added to the suiteQueryString attribute if embedding Suite within a website.
General URL Criteria
These parameters are workflow independent and affect Suite more as a whole in terms of basic configuration. Required parameters in this table are needed for ANY workflow to function properly while optional parameters will be compatible with any workflow. See the workflow-specific tables for workflow-specific requirements.
| Parameter | Type | Example | Description | Required |
|---|---|---|---|---|
| accountId | Integer | 564645 | Account ID provided by tech support. This will ALWAYS be required. |
Yes |
| stockId | String | CL600151 | If the stock identifier for the inventory vehicle is passed in, it will be disclosed in leads. |
No |
| extColor | String | White | If the exterior color name is passed in, it will be disclosed in leads. |
No |
| intColor | String | Grey | If the interior color name is passed in, it will be disclosed in leads. |
No |
| showHeader | String | false | When showHeader=false, then vehicle data are not displayed in the vehicle header area of the UI. If the showHeader parameter value is not passed in, then the Suite's default behavior is to show the header (just as if showHeader=true was passed). The content of a lead sent from Suite is not affected by this setting. |
No |
| picture | String | http://qaservices.example.com/ vehiclephoto/13560.jpg | This parameter identifies the URL of a vehicle image. When present, the image is displayed in the Email Summary. |
No |
PaymentDriver URL Criteria
If you are using the PaymentDriver Plug-in as a stand-alone application, the recommended best practice is to use the PaymentDriver widget. Details about implementing the PaymentDriver widget can be found at https://ebusiness.dealertrack.com/SuiteDemo/imp_paymentwidget.jsp. When using the PaymentDriver widget, the same parameters listed for the URL criteria below are instead passed in the widget's suiteQueryString to open the PaymentDriver Plug-in. Or you may provide vehicle information as parameters on the Suite's URL.
There are two possible methods to pass payment parameters. The first one uses Chrome Data Solutions' style identification numbers (style IDs). This is the preferred method as it will generally result in a more accurate payment and incentive data. The second method is to use Automotive Lease Guide (ALG) vehicle description names. Note that ALG descriptions must be exact or else the payment and incentive data can be incomplete or not return any data. Also, you must use "%20" to indicate spaces in any of the name parameters (see the 3rd URL example in this section).
The following parameters are used for the stand-alone usage of the PaymentDriver Plug-in:
| Parameter | Type | Example | Description | Required |
|---|---|---|---|---|
| zip | 5-digit | 97232 | A zip code that the application will use to determine the location payments will be calculated for. |
Yes |
| styleId | Integer | 335634 | A positive, numeric value that is the designated Chrome Data Solutions style ID for the specific vehicle. This will be used by the Suite to retrieve a year, make, model, and style which will be used to display in the Suite, determine rate and incentive information, and be provided in leads. * Either styleId or vin must be provided for PaymentDriver to properly display rates and incentives. |
Yes* |
| year | Integer | 2012 | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. |
No |
| make | String | Dodge | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. |
No |
| model | String | Journey | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. The provided value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. |
No |
| style | String | FWD 4dr SE | This value will be used to enhance the accuracy of data gathered using a vin or styleId and while not required is highly recommended. The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin. |
No |
| price | Integer | 18995 | The quoted price of the vehicle. This is used for both the display and processing of the payment. This price is used for both loan and lease calculations unless the leasePrice parameter (below) is passed for lease calculations. |
Yes |
| msrp | Integer | 19775 | Including the Manufacturer's Suggested Retail Price for the vehicle is highly recommended to increase the accuracy of lease payments. |
No |
| leasePrice | Integer | 20195 | This optional field is available for use by dealerships who wish to base lease calculations off of a different price than their loan pricing (which uses the price parameter). This is usually the case when either dealer cash is available for a lease, or a dealership includes finance only incentives in their advertised prices (and as a result typically has "Ignore Cash Incentives" setting turned on). |
No |
| downPmt | Integer | 2000 | If provided, this value is used as the down payment for the initial loan and lease calculations unless the leaseDownPmt parameter (below) is passed for lease calculation. | No |
| leaseDownPmt | Integer | 2000 | If provided, this value is used as the down payment for the initial lease calculation. | No |
| mileage | Integer | 13 | The current odometer reading of the vehicle. |
No |
| type | String | used | One of four values that describe the condition of the car: new, used, certified, and demo. |
Yes |
| dealerId | Integer | 987654 | The payment settings, dealer name and contact info for the identified dealer will be used. | Yes |
| vin | String | 9N1AB6AP9CL640151 | The Vehicle Identification Number (vin) will be used by the Suite to retrieve a year, make, model, and style which will be used to display in the Suite, determine rate and incentive information, and be provided in leads. If the Vehicle Identification Number is passed in, it will also be disclosed in leads. * Either styleId or vin must be provided for PaymentDriver to properly display rates and incentives. |
Yes* |
| transmission | String | automatic | When a transmission string is passed in, the service can use it to enhance VIN decoding. This string is ignored if a vin parameter is not also passed. Acceptable strings include: |
No |
| destinationAmount | Integer | 500 | When a destination amount is passed in, the amount is added to the lease and loan prices before the request is sent to the PaymentDriver service so that this fee is factored into the payment calculation. The amount is not included in the price displayed to the user but is displayed as an additional "Destination & Delivery" fee. |
No |
Examples (non-functional URLs for parameter syntax reference only):
FinanceDriver URL Criteria
If you're using the FinanceDriver Plugin as a stand-alone application, you may optionally provide vehicle information as parameters in the Suite's URL (if you want the leads generated by the Suite to include vehicle information). This is in contrast to other Digital Retailing Suite workflow combinations where the FinanceDriver Plug-in inherits vehicle information captured earlier in the workflow.
| Parameter | Type | Example | Description | Required |
|---|---|---|---|---|
| zip | 5-digit | 97232 | The FinanceDriver Plug-in does not require and does not use the Zip Code. |
No |
| styleId | Integer | 335634 | A positive, numeric value that is the designated Chrome Data Solutions style ID for the specific vehicle. This will be used by the Suite to retrieve a year, make, model, and style which will be used to display in the Suite and on leads. *To display vehicle information on the lead in www.Dealertrack.com My Leads tab one of the following must be provided: |
No* |
| year | Integer | 2012 | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. *To display vehicle information on the lead in www.Dealertrack.com My Leads tab one of the following must be provided: |
No* |
| make | String | Dodge | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. *To display vehicle information on the lead in www.Dealertrack.com My Leads tab one of the following must be provided: |
No* |
| model | String | Journey | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. The provided value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. *To display vehicle information on the lead in www.Dealertrack.com My Leads tab one of the following must be provided: |
No* |
| style | String | FWD 4dr SE | This value will be used to enhance the accuracy of data gathered using a vin or styleId and while not required is highly recommended. The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin. *To display vehicle information on the lead in www.Dealertrack.com My Leads tab one of the following must be provided: |
No* |
| price | Double | 18995 | The quoted price of the vehicle. |
No |
| mileage | Integer | 13 | The current odometer reading of the vehicle. |
No |
| type | String | used | One of four values that describe the condition of the car: new, used, certified, and demo. Note: When type is set to demo, the FinanceDriver "Long Form" credit application will have demo selected on the Vehicles page, and pass demo as the type on the emailed leads. |
No |
| dealerId | Integer | 987654 | The dealerId identifies the dealer whose prequalification criteria, credit bureau, lender(s), and other preferences (established on Dealertrack.com) will be used by the FinanceDriver service. | Yes |
| vin | String | 9N1AB6AP9CL640151 | The Vehicle Identification Number (vin) will be used by the Suite to retrieve a year, make, model, and style which will be used to display in the Suite and be provided in leads. If the Vehicle Identification Number is passed in, it may be disclosed in leads. *To display vehicle information on the lead in www.Dealertrack.com My Leads tab one of the following must be provided: |
No* |
| transmission | String | automatic | When a transmission string is passed in, the service can use it to enhance VIN decoding. This string is ignored if a vin parameter is not also passed. Acceptable strings include: |
No |
| tradeInYear | Integer | 2014 | The year of the trade in vehicle. When provided, the value will be used to pass trade vehicle year to FD service, leads and consumer emails.
*To display trade vehicle information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeInMake | String | Kia | The make of the trade in vehicle. When provided, the value will be used to pass trade vehicle make to FD service, leads and consumer emails.
*To display trade vehicle information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeInModel | String | Sorento | The model of the trade in vehicle. When provided, the value will be used to pass trade vehicle model to FD service, leads and consumer emails.
*To display trade vehicle information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeInStyle | String | LX | The style of the trade in vehicle. When provided, the value will be used to pass trade vehicle style to FD service, leads and consumer emails.
*To display trade vehicle information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeValue | Double | 8000 | The appraised value of a trade in vehicle. When provided, the value will be used to pass trade value to FD service, leads and consumer emails.
*To display trade Value information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeOwe | Double | 5000 | The amount owed on a trade in vehicle. When provided, the value will be used to pass trade amount owed to FD service, leads and consumer emails.
*To display amount Owed on tradein on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeMonthlyPmt | Double | 250 | The monthly amount owed on a trade in vehicle. When provided, the value will be used to pass the monthly trade amount owed to FD service.
*To display monthly amount owed on tradein on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tradeLienHolder | String | Bank of America | The lien holder on a trade in vehicle. When provided, the value will be used to pass the trade in vehicle's lien holder's name to FD service.
*To display lien holder on tradein on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| estPmt | Integer | 2000 | The estimated monthly payment of the customer selected vehicle. When provided, the value will be used to pass estimated monthly payment to FD service, leads and consumer emails.
*To display estimated monthly payment information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| downPmt | Integer | 2000 | The customer provided down payment. When provided, the value will be used to pass down payment to FD service, leads and consumer emails.
*To display down Payment information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| apr | Double | 1.2 | The annual percentage rate offered by lender for loan purposes. When provided, the value will be used to pass the APR to FD service, leads and consumer emails. This applies to finance credit applications only.
*To display apr information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| financed | Double | 20000 | The total amount financed of a finance credit application. When provided, the value will be used to pass the total amount financed to FD service, leads and consumer emails. This applies to finance credit applications only.
*To display amount Financed information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| dueAtSigning | Double | 2345 | The total due at signing amount of a lease credit application. When provided, the value will be used to pass due at signing to FD service, leads and consumer emails. This applies to lease credit applications only.
*To display due at signing information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| score | Integer | 799 | The credit score of the applicant. When provided, the value will be used to pass credit score to FD service, leads and consumer emails.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| tier | String | 3 | The credit tier of the applicant. When provided, the value will be used to pass credit tier to FD service and leads.
*To display credit tier information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| term | Integer | 36 | The finance/lease term of the consumer selected vehicle. When provided, the value will be used to pass the monthly payment term count to FD service, leads and consumer emails.
*To display term information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| defaultFinanceType | String | lease/loan | The finance type (loan/lease) of an applicant credit application. When provided, the finance type will be used to pass finance type to FD service, leads and consumer emails.
*To display selected finance type information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| moneyFactor | Double | 0.0028 | The amount of interest charged on a lease with monthly payments.When provided, the value will be used to pass money factor to FD service and leads.
*To display money factor information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| leaseMileage | Integer | 12000 | The annual mileage set by the customer for a leased vehicle.When provided, the value will be used to pass lease annual mileage to FD service and leads.
*To display lease Annual Miles on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| fdTagName | String | MONFACTOR | Custom Tag values for the Credit Application. Should be provided as fdTagName1, fdTagName2...fdTagName10(Max 10). When provided, will be passed to FD Service and Leads.
*To display Additional Financial Data on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| fdTagValue | String | 0.89 | Custom Tag values for the Credit Application. Should be provided as fdTagValue1, fdTagValue2...fdTagValue10(Max 10). When provided, will be passed to FD Service and Leads.
*To display Additional Financial Data on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| salesTax | Double | 110.56 | Sales Tax value for the Credit Application. When provided, will be passed to FD Service and Leads.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| Rebate | Double | 120.44 | Rebate value for the Credit Application. When provided, will be passed to FD Service and Leads.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| dealerFees | Double | 220.67 | Dealer Fees value for the Credit Application. When provided, will be passed to FD Service and Leads.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| dmvFees | Double | 345.98 | DMV Fees value for the Credit Application. When provided, will be passed to FD Service and Leads.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| acqFees | Double | 165.32 | Acquisition Fees value for the Credit Application. When provided, will be passed to FD Service and Leads. This applies to lease credit applications only.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
| warranty | Double | 16.45 | Warranty value for total amount of all aftermarket products for the Credit Application. When provided, will be passed to FD Service and Leads.
*To display credit score information on the lead in www.Dealertrack.com My Leads tab the following must be provided: |
No* |
PaymentDriver > FinanceDriver Workflow
Only those parameters specified below should be included in the URL that initiates this workflow.
| Parameter | Type | Example | Description | Required |
|---|---|---|---|---|
| zip | 5-digit | 97232 | The FinanceDriver Plug-in does not require and does not use the Zip Code. |
Yes |
| styleId | Integer | 335634 | A positive, numeric value that is the designated Chrome Data Solutions style ID for the specific vehicle. This will be used by the Suite to retrieve a year, make, model, and style which will be used to display in the Suite, determine rate and incentive information, and be provided in leads. * Either styleId or vin must be provided for PaymentDriver to properly display rates and incentives. |
Yes* |
| year | Integer | 2012 | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. |
No |
| make | String | Dodge | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. |
No |
| model | String | Journey | The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. The provided value will be used by the Suite to retrieve data if there is a problem with the provided vin or styleId and it is recommended, but not required, that this value be provided. |
No |
| style | String | FWD 4dr SE | This value will be used to enhance the accuracy of data gathered using a vin or styleId and while not required is highly recommended. The provided value will be used for display instead of the data gathered by the Suite from the vin or styleId. This value will be used by the Suite to retrieve data if there is a problem with the provided vin. |
No |
| price | Integer | 18995 | The quoted price of the vehicle. This is used for both the display and processing of the payment. This price is used for both loan and lease calculations unless the leasePrice parameter (below) is passed for lease calculations. |
Yes |
| msrp | Integer | 19775 | Including the Manufacturer's Suggested Retail Price for the vehicle is highly recommended to increase the accuracy of lease payments. |
No |
| leasePrice | Integer | 20195 | This optional field is available for use by dealerships who wish to base lease calculations off of a different price than their loan pricing (which uses the price parameter). This is usually the case when either dealer cash is available for a lease, or a dealership includes finance only incentives in their advertised prices (and as a result typically has "Ignore Cash Incentives" setting turned on). |
No |
| mileage | Integer | 13 | The current odometer reading of the vehicle. |
Yes |
| type | String | used | One of four values that describe the condition of the car: new, used, certified, and demo. Note: When the type is set to demo, then PaymentDriver will pass the used type, the FinanceDriver "Long Form" credit application will have demo selected on the Vehicles page, and will pass demo as the type on our leads. |
Yes |
| dealerId | Integer | 987654 | The dealerId identifies the dealer whose prequalification criteria, credit bureau, lender(s), and other preferences (established on Dealertrack.com) will be used by the FinanceDriver service. |
Yes |
| vin | String | 9N1AB6AP9CL640151 | The Vehicle Identification Number (vin) will be used by the Suite to retrieve a year, make, model, and style which will be used to display in the Suite, determine rate and incentive information, and be provided in leads. If the Vehicle Identification Number is passed in, it will also be disclosed in leads. * Either styleId or vin must be provided for PaymentDriver to properly display rates and incentives. |
Yes* |
| configCode | String | 5UI5776B | When a configCode is passed in, it will be included in the lead that is sent to the CRM, so they know exactly what vehicle and options the customer is interested in |
No |
PaymentDriver > FinanceDriver Workflow URL Parameterization Example
You can test the effect of using URL parameters by replacing the asterisks (*) with appropriate valid values.
Jumpflow
Only those parameters specified below should be included in the URL that initiates this workflow.
| Parameter | Type | Example | Description | Required |
|---|---|---|---|---|
| mktgCode | String | xcf34fd | A marketing code to be appended as a URL parameter to the Jumpflow link. |
No |