Use this form to generate all the code you need to build a standalone prequalification form page for your site.
All CarZing API requires the following mandatory HTTP header:
x-com-carzing-api-key
- the header should contains the {API_KEY}
All POST requests made to CarZing API should use the following content type:
application/json
API root endpoint
https://{CARZING_DOMAIN_NAME}/api/DealerWS
HTTP Status codes
POST /SubmitPrequalification
Request POST Body:
Substitute the corresponding customer information accordingly (highlighted in bold)
{
"FirstName":"{FIRST NAME}",
"LastName":"{LAST NAME}",
"PhoneNumber":"{PHONE NUMBER}",
"DateOfBirth":"{DATE OF BIRTH}",
"Address":"{STREET ADDRESS}",
"City":"{CITY}",
"State":"{STATE ABBR}",
"Zip":"{ZIP}",
"Email":"{EMAIL ADDRESS}",
"SSN":"",
"RentMortgage":1100,
"LengthOfAddressYear":"2,
"LengthOfAddressMonth":"2,
"MaxCashDown":2000,
"MonthlyIncome":5000,
"LengthOfJobYear":1,
"LengthOfJobMonth":1,
"IncomeType":1,
"TradeInValue":6000,
"TradeInPayoff":1000,
}
Response:
{
"Success":true,
"IsNoHit":false,
"IsFrozen":false,
"IsFraudAlert":false,
"SessionId":"8f2e13f98f40458382658b246f29c6d1"
}
Parameters | Values |
---|---|
IncomeType |
|
POST /ImportVehicles
Request POST Body: (multiple vehicles can be included in the JSON array)
Substitute the corresponding vehicle information accordingly (highlighted in bold)
[{
"DCCompanyID": "881234",
"Vin": "J1BF1FK0GU147428",
"StockNo": "302518",
"VehiclePrice": 25413,
"Year": 2014,
"Make": "Toyota",
"Model": "Camry",
"Trim": "SE Sedan 4D",
"Mileage": 12566,
"ExteriorColor": "Black",
"InteriorColor": "Black",
"BodyType": "Sedan",
"Doors": "4",
"Engine": "4-Cyl, 2.5 Liter",
"DriveTrain": "FWD",
"FuelType": "Gasoline",
"Transmission": "Auto, 6-Spd SeqShft",
"TransmissionType": "Automatic",
"BodyStyle": "Sedan",
"Cylinders": "4",
"HighwayMPG": "35",
"CityMPG": "25",
"VehicleClass": "Used",
"Photos": [
{
"ImageUrl": "{PHOTO1_URL}"
},
{
"ImageUrl": "{PHOTO2_URL}"
}
],
"Equipments": [
{
"CodeDescription": "Stability Control",
"EquipmentType": "Equipment"
},
{
"CodeDescription": "ABS (4-Wheel)",
"EquipmentType": "Equipment"
}
]
}]
Response:
[{
"Success":true,
"InventoryID":"669923af-c3f5-e511-80f4-005056827101",
"DCCompanyID": "881234",
"Vin": "J1BF1FK0GU147428",
"StockNo": "302518"
}]
Parameters | Values |
---|---|
VehicleClass |
|
TransmissionType |
|
POST /ComputePayment
Mulitple Inventory IDs or combination of DC Company ID, VIN and Stock Number (in the "Inventory" field) can be provided to identify the list of vehicles on which the compute should be performed.
** Note: use "0" as term for the service to determine the longest term
{
// FICO should be provided only for
// compute based on FICO only (i.e. no pre-qual session has
// been established)
"FICO": 750,
// PreQualSessionId should contain the session ID
// from the "Submit Pre-Qualification Response"
// when compute based on pre-qual session
"PreQualSessionId": {SESSION_ID},
"DownPayment": 1500,
"Term": 72
"InventoryIDs": [
"{INVENTORY_ID}",
"{INVENTORY_ID}"
],
// As an alternative to InventoryIDs,
// client application can provide combination of DC Company ID,
// VIN and Stock Number for identifying vehicles
"Inventory": [
{
"DCCompanyID": "881234",
"Vin": "J1BF1FK0GU147428",
"StockNo": "302518"
},
{
"DCCompanyID": "881234",
"Vin": "J1BF1FK0GU147429",
"StockNo": "302519"
},
]
}
Response:
[{
"Approved": true,
"MonthlyPayment": 325,
"DownPayment": 1500,
"Term": 60,
"APR": 4.99,
"AmountFinanced": 18999,
"StateTax": 18090,
"InventoryID": "669923af-c3f5-e511-80f4-005056827101"
}]
Many DMS providers have already been integrated with the CarZing experience. If you currently use one of them, it should be a snap to set up.
These are the providers currently supported:
We support the widely accepted standard HomeNet feed format. The only restriction we add on top of this is the file naming convention (DCID_MMDDYYYY.csv).
For example, if your DCID was 123456, you would use this file format if transmitting on 11/28/2016: 123456_11282016.csv