AccuTrade Perseus API v1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
API for AccuTrade's Perseus project.
View our Swagger documentation here: https://perseus-api-qa.accu-trade.com/api/docs/
Download our Postman example here: accutrade_perseus_api.postman_collection.json
Overview
AccuTrade
AccuTrade provides a smart, fast way for automobile dealers, resellers, and digital retailers to capture consumer sales and trade-in leads, close deals, liquidate inventory, and get accurate vehicle valuations – all backed by our Price Assurance guarantee.
AccuTrade Products
We’ve built a precise, value-based platform that powers a suite of innovative products to meet these goals, including:
- Instant Cash Offer consumer application for dealers, resellers, and digital retailers to provide guaranteed offers and estimates to their consumers seeking to sell or trade-in their vehicle.
- Appraiser application for dealers to appraise vehicles, view valuations, convert leads to sales, and manage and sell inventory - all powered by live wholesale and retail market data.
- VIN-dow application integrates the Appraiser product within auctions.
Our applications support integrations with leading online marketplaces such as SmartAuction, IAS, and DIA, as well as dealership software including vAuto, MADE Logistics, Dealer Vault, and VINTEL.
Powering the application experience is our Dealer Console administrative tools for provisioning dealerships and automotive groups, managing users, and personalizing the product experience, and managing integrations.
Perseus API
The Perseus API is our consumer application vehicle valuation integration API that allows dealers, resellers, and digital retailers to provide Instant Cash Offers to consumers, powered by our Price Assurance guarantee. It can be used by partners to quickly and accurately get a price on a used vehicle based on the license plate, VIN, or year, make, model, and styles of a vehicle, along with other vehicle details and conditions.
Using the API, partners can integrate the application into their system as a ready-to-go solution with an iframe, or build their own applications frontend for full control of the user experience.
FAQs
Do I need to add a unique dealership ID number to the iframe URL for each dealership we add the integration to?
Yes. Each iframe URL needs to contain a unique dealership ID number provided to the dealership by AccuTrade.
We have made it easy to help you locate a dealership’s ID number. Please refer to the instructions provided in the Iframe >> URL Parameters section of this document.
Can I provide guaranteed offers to consumers if they only supply their vehicle’s year, make, model, and trim?
Yes, we support guaranteed offers if consumers provide their VIN, license plate, or their vehicle’s year, make, model, and trim.
Providing a guaranteed offer if consumers provide only their vehicle’s year, make, model, and trim is a setting controlled internally by AccuTrade. Please contact your AccuTrade representative to request this configuration change to your system key.
Can I send AccuTrade the consumer’s name, email, and phone number?
Yes. Please refer to the instructions provided in the Iframe >> InBound Communications section of this document.
Can I send AccuTrade the consumer’s vehicle of interest?
Yes. Please refer to the instructions provided in the Iframe >> InBound Communications section of this document.
Can I stop AccuTrade from sending an ADF to the dealership’s CRM? We are sending an ADF to the dealership’s CRM, and now they are receiving duplicates.
You can stop AccuTrade from sending an ADF to the dealership’s CRM by adding this parameter to the URL of the iframe: lt=suppresscrm
Please refer to the instructions provided in the Iframe >> URL Parameters section of this document.
After an offer is generated, can a consumer update their vehicle’s details, conditions, or other data?
No, a consumer may not update any information related to an offer they have received.
However, using AccuTrade’s Appraiser application, a dealership or other partner can review the prospect’s information, appraise the vehicle, and update information about the offer.
IFrame Implementation
The iframe is a ready-to-go solution to integrate our Instant Cash Offer application into your offerings.
URL
For the iframe, you will be provided with URLs that include a unique system key to power the application.
URL of pre-production iframe: https://perseus-consumer-qa.rhcapl.com?dlr=SYSTEM_KEY&uuid=123456
URL of production iframe: https://cashoffer.accu-trade.com?dlr=SYSTEM_KEY&uuid=123456
Demo Link https://perseus-demo.rhcapl.com/dr/index.html
URL Parameters
There are additional URL parameters that you may need or want to add when implementing the iframe URL on a website.
The required URL parameters are:
- dlr - The System Key of the partner using the API (required)
- uuid The AccuTrade Dealer ID number for the dealership the iframe will be added on (required) - use the search API to determine if a dealership is in AccuTrade's system.
Other common URL parameters that partners use are:
- lt=suppresscrm - To prevent leads from being sent to the dealership's CRM; this parameter is usually added if the partner will be sending the leads to the dealership themselves.
- lt=suppresspii - To prevent leads from being sent to the Appraiser Tool and dealership's CRM until the opt-in or dealer contact API is called; once called leads will be revealed in the Appraiser tool and sent to dealership's CRM.
- showscroll=true - To force the iframe scrollbar to display.
- plateEntry=False - To disable the option to display license plate as a way to initiate a vehicle valuation.
- pt1=VALUE - Pass through parameters will be included in the ADF as
<pt1>VALUE</pt1>, pt1 - pt9 can be used)
URL parameters that partners use to pass in vehicle information are:
- cvin - The VIN of the consumer's vehicle.
- cplate - The License Plate number of the consumer’s vehicle.
- cstate - The State or Province of the License Plate of the consumer’s vehicle.
- cyear - The Model Year of the consumer’s vehicle. If you do not know the License Plate or VIN of the consumer’s vehicle, then pass in the Year via this parameter, as well as the Make (
cmake), Model (cmodel), and Trim (ctrim). - cmake - The Make of the consumer’s vehicle. If you do not know the License Plate or VIN of the consumer’s vehicle, then pass in the Make via this parameter, as well as the Year (
cyear), Model (cmodel), and Trim (ctrim). - cmodel - The Model of the consumer’s vehicle. If you do not know the License Plate or VIN of the consumer’s vehicle, then pass in the Model via this parameter, as well as the Year (
cyear), Make (cmake), and Trim (ctrim). - ctrim - The Trim (also known as the Style) of the consumer’s vehicle. If you do not know the License Plate or VIN of the consumer’s vehicle, then pass in the Trim via this parameter, as well as the Year (
cyear), Make (cmake), and Model (cmodel).
Additional information can be sent to the iframe via Post Message. Refer to the inbound-communications section for details.
Other URL parameters are:
- ot - Saved as
Offer.origin_type. Used to help determine lead source in the ADF. The Appraiser will set this to “AccuTrade Appraiser” when you click Launch Customer Experience. The default value for widget leads is “Dealer Website”. - originType - Same as "ot". If both are specified, originType takes precedence.
- lt - Saved as
Offer.lt. Used to help determine if leads should be sent based on if the value is blank, “showroom” or “suppresscrm”. The Appraiser will set this to “showroom” when you click Open Showroom in Dealer Console. - ls - If set, the front-end shows a “dealerView” of the offer. Usually this param is set by/in the Appraiser.
- pagid - PAG ID related to the offer. Saved as
Offer.pag_id. Used to lookup theOffer.pag_nameandOffer.pag_logo_url. - vdpid - The partner dealer id. Used in some cases to lookup and store the
Offer.dealer. - odid - The OEM dealer id. Used in some cases to lookup and store the
Offer.dealer. - vdp - Saved as
Offer.vdp. - cid - Saved as
Offer.cid. - affcid - Saved as
Offer.aff_cid. - tc_v - Saved as
Offer.visitor_uuid. - partnerOfferId - Saved as
Offer.partner_offer_id.
URL Examples
URL with the partner's system key:
https://perseus-consumer-qa.rhcapl.com?dlr=SYSTEM_KEY
URL with the partner's system key and a dealership's AccuTrade dealer ID number:
https://perseus-consumer-qa.rhcapl.com?dlr=SYSTEM_KEY&uuid=123abc
URL with the partner's system key, a dealership's AccuTrade dealer ID number, and the configuration to suppress leads from being sent to the dealership's CRM:
https://perseus-consumer-qa.rhcapl.com?dlr=SYSTEM_KEY&uuid=123abc<=suppresscrm
Outbound Communications
The iframe communication is handled through window.postMessage(). All relevant information relating to the vehicle valuation is wrapped in an "atOutbound" object. Anytime the height of the iframe's content changes, the price is adjusted, or the estimate/offer is complete, we send the corresponding data.
When the "estimateComplete" boolean is sent, all pertinent data in the "details" object should be consumed and the iframe should be closed.
Outbound Post Message Structure
Here is a summary of the data sent in the object.
// outbound postMessage structure
"atOutbound": {
"newHeight": "number",
"priceAdjustment": "boolean",
"estimateComplete": "boolean",
"details": {
"offer": "string",
"expirationDate": "string",
"price": {
"range": ["number", "number"],
"offer": "number"
},
"vehicle": {
"image": "string",
"year": "number",
"make": "string",
"model": "string",
"style": "string",
"vin": "string",
"mileage": "number"
},
"rawData": {
"vehicle_color": {
"name": "string",
"hex_code": "string"
},
"vacs": [
{
"description": "string",
"amount": "number",
"selected": "boolean"
}
],
"is_original_owner": "boolean",
"is_liened": "boolean",
"liened_type": "string",
"loan_owed_amount": "number",
"lease_monthly_payment": "number",
"lease_number_payments": "number",
"lease_amount_remaining": "number",
"has_accident": "boolean",
"insurance_payout_amount": "number",
"has_frame_damage": "boolean",
"carfax_has_bad_vhr": "boolean",
"has_external_damage": "boolean",
"external_damage_amount": "boolean",
"front_tire_age": "string",
"rear_tire_age": "string",
"has_mechanical_issues": "boolean",
"has_mechanical_ac": "boolean",
"has_mechanical_brakes": "boolean",
"has_mechanical_catalytic_converter": "boolean",
"has_mechanical_engine": "boolean",
"has_mechanical_exhaust": "boolean",
"has_mechanical_head_gasket": "boolean",
"has_mechanical_oil_leak": "boolean",
"has_mechanical_sunroof_moonroof": "boolean",
"has_mechanical_suspension": "boolean",
"has_mechanical_transmission": "boolean",
"has_mechanical_other": "boolean",
"mechanical_other_note": "string",
"has_warning_lights": "boolean",
"has_warning_lights_abs": "boolean",
"has_warning_lights_srs": "boolean",
"has_warning_lights_battery": "boolean",
"has_warning_lights_brake": "boolean",
"has_warning_lights_engine": "boolean",
"has_warning_lights_tpms": "boolean",
"has_warning_lights_suspension_fault": "boolean",
"has_warning_lights_traction_control": "boolean",
"has_modifications": "boolean",
"has_modifications_exhaust": "boolean",
"has_modifications_performance": "boolean",
"has_modifications_stereo": "boolean",
"has_modifications_spoiler": "boolean",
"has_modifications_sunroof_moonroof": "boolean",
"has_modifications_suspension_lifted": "boolean",
"has_modifications_suspension_lowered": "boolean",
"has_modifications_wheel": "boolean",
"has_aftermarket_tint": "boolean",
"has_odor": "boolean",
"has_other_issues": "boolean",
"is_salvage_title": "boolean",
"is_rebuilt_title": "boolean",
"has_fire_damage": "boolean",
"has_flood_damage": "boolean",
"was_stolen": "boolean",
"other_issues_repair_cost": "number"
}
}
}
- atOutbound
- newHeight (anytime the height changes, we send this)
- priceAdjustment (anytime the price range changes, based on user input, we send this. retrieve price values from the details.price.range property)
- estimateComplete (when the offer/estimate is complete we send this)
- details (contains offer/estimate details)
- offer (the offer code)
- expirationDate (the offer expiration date)
- price (contains price data)
- range (the current range, as presented to the user)
- offer (the offer price, if available)
- range (the current range, as presented to the user)
- vehicle (contains the consumer's trade vehicle data)
- image (the url to the vehicle image we're using)
- year (the vehicle year)
- make (the vehicle make)
- model (the vehicle model)
- style (the vehicle style/trim)
- vin (the vehicle VIN, if available)
- mileage (the vehicle mileage)
- image (the url to the vehicle image we're using)
- rawData (contains all of the offer data including details and conditions)
- offer (the offer code)
- newHeight (anytime the height changes, we send this)
See JavaScript column for basic listener example ->
// postMessage listener (basic example)
window.addEventListener('message', function (e) {
var data = (e.data) ? JSON.parse(e.data) : {};
if (data && data.atOutbound) {
data = data.atOutbound;
// Consume new height
if (data.newHeight) {
document.getElementById("accuTradeFrame").style.height = data.newHeight + 'px';
}
// Consume price adjustment
if (data.priceAdjustment) {
console.log('price change', data.details.price.range[0] + ' - ' + data.details.price.range[1]);
}
// Consume estimate complete
if (data.estimateComplete) {
document.getElementById("tradeDetailsContent").style.display = 'none';
document.getElementById("tradeEstimateHeader").classList.remove('de-emphasise');
document.getElementById("tradeDetailsHeader").classList.add('de-emphasise');
document.getElementById("tradeEstimateContent").innerHTML = '<img src="' + data.details.vehicle.image + '" />' +
'<div>' + data.details.vehicle.year + '</div>' +
'<div>' + data.details.vehicle.make + '</div>' +
'<div>' + data.details.vehicle.model + '</div>' +
'<div>' + data.details.vehicle.style + '</div>' +
'<div>price range: ' + data.details.price.range[0] + ' - ' + data.details.price.range[1] + '</div>' +
'<div>price offer: ' + data.details.price.offer + '</div>' +
'<div>offer code: ' + data.details.offer + '</div>';
}
}
});
Inbound Communications
Sending Consumer Information
In some of our iframe integrations, we remove the prospecting page so as not to collect the consumer’s name, email address, and other relevant information, since this information is collected by the partner by other means. Additionally, the consumer may indicate outside of our integration that they are interested in trading-in their vehicle and provide their desired vehicle of interest (VOI)
In both of these instances, the consumer’s information and/or VOI data can be sent to the iframe via postmessage. Doing so allows AccuTrade to append the data to the lead when it is sent to the dealership’s CRM via ADF and/or when it is made available to the dealership in AccuTrade’s Appraiser application.
We wait until we receive an “initComplete” property on the “atOutbound” object, which lets us know that the iframe is ready to receive messages, then the consumer data can be sent to the iframe via postmessage. The consumer object is to be passed inside of an “atInbound” object, which is the wrapper object that gets consumed by the application running in the iframe.
Inbound Post Message Structure
Here is a summary of the data sent in the object.
// inbound postMessage structure
"atInbound": {
"original_owner": "boolean",
"plate": "string",
"state": "string",
"vehicle_exterior_color": "string",
"vehicle_guid": "string",
"vehicle_interior_color": "string",
"vehicle_make": "string",
"vehicle_mileage": "number",
"vehicle_model": "string",
"vehicle_photos": "array of URL strings",
"vehicle_style": "string",
"vehicle_vin": "string",
"vehicle_year": "string",
"consumer": {
"firstName": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"postalCode": "string"
},
"voi": {
"type": "string",
"year": "string",
"make": "string",
"model": "string",
"trim": "string",
"vin": "string",
"stockNumber": "string",
"odometer": "number"
}
}
- atInbound
- vehicle_vin (trade vehicle VIN number)
- plate (license plate number of trade vehicle)
- state (license plate state of trade vehicle)
- vehicle_guid (AccuTrade vehicle identifier of trade vehicle)
- vehicle_year (trade vehicle year)
- vehicle_make (trade vehicle make)
- vehicle_model (trade vehicle model)
- vehicle_style (trade vehicle style)
- vehicle_mileage (trade vehicle mileage)
- original_owner (indicator if consumer is original owner of trade vehicle)
- vehicle_exterior_color (exterior color of trade vehicle)
- vehicle_interior_color (interior color of trade vehicle)
- vehicle_photos (array of trade vehicle photo URLs)
- consumer (contains consumer details)
- firstName (the consumer's first name)
- lastName (the consumer's last name)
- email (the consumer's email)
- phone (the consumer's phone)
- postalCode (the consumer's postal code)
- firstName (the consumer's first name)
- voi (contains vehicle of interest data)
- type (the voi type: [new, used, cpo])
- year (the voi year)
- make (the voi make)
- model (the voi model)
- trim (the voi trim)
- vin (the voi vin)
- stockNumber (the voi stock number)
- odometer (the voi odometer)
- vehicle_vin (trade vehicle VIN number)
See JavaScript column for basic sending example ->
// sending consumer and voi data via postMessage (example)
if (data && data.atOutbound) {
data = data.atOutbound;
// Consume initialization complete
if (data.initComplete) {
var incomingData = {
"atInbound": {
"consumer": {
"firstName": "Tom",
"lastName": 'Smith',
"email": "test@accu-trade.com",
"phone": "7075551212",
"postalCode": "32837"
},
"voi": {
"year": "2016",
"make": "Honda",
"model": "Fit",
"trim": "LX 4 DOOR HATCHBACK 1.5L 4 CYL"
}
}
};
// Send consumer and voi data
document.getElementById('accuTradeFrame').contentWindow.postMessage(incomingData, '*');
}
}
Use this demo site to experiment with sending data to the iframe: https://perseus-demo.rhcapl.com/data
Lease Self-Inspection Application
The following API can be used to send lease customer vehicle data to AccuTrade so we can provide you with a unique URL for each customer.
This URL can then be provided to consumers to complete a self-inspection of their leased vehicle.
request body data
{
"lease_company": "bcd52bd14b",
"loan_id": "loan123",
"end_date": "2020-05-31",
"vin": "1HGCM56427A222280",
"trim": "LX 4 DOOR SEDAN 2.4L 4 CYL",
"options": [{
"name": "MANUAL TRANSMISSION",
"selected": false
}],
"first_name": "Kyle",
"email": "test@accu-trade.com"
}
// response data
{
"uuid": "97c02302-a1e1-4b32-a1b3-5b4af404bc85", // this uuid is important
"lease_company": "bcd52bd14b",
"end_date": "2020-05-31",
"loan_id": "loan123",
"vin": "1HGCM56427A222280",
"trim": "LX 4 DOOR SEDAN 2.4L 4 CYL",
"options": [{
"name": "MANUAL TRANSMISSION",
"selected": false
}],
"offer": null,
"messages": []
}
Assuming a successful response, a link to the lease return can be generated using the uuid. The production URL format for the lease return is:
https://self-inspection.accu-trade.com/?dlr=TOKEN&aid=UUID
API Implementation
As an alternative to the iframe implementation, partners can choose to use our API to develop their own application. Typically the API is used for a guaranteed vehicle valuation or a vehicle value estimate. This usually involves these steps:
- Acquire Vehicle Details
- Load Vehicle Specifics
- Build/Retrieve Vehicle Valuation
a. Vehicle Value Estimate
b. Multi-Step Guaranteed Vehicle Valuation
c. Single-Step Guaranteed Vehicle Valuation
Before any type of vehicle valuation can be applied an AccuTrade vehicle must be selected.
(1) Acquire Vehicle Details
There are several ways to select an AccuTrade vehicle:
By VIN:
a. Use vehicle by VIN endpoint
b. Note gid in response
c. Postman Example:AccuTrade Perseus API > Vehicle by VINBy License Plate:
a. Use Plate to VIN endpoint
b. Then, use vehicle by VIN endpoint
c. Note gid in responseBy YMMS:
a. Use vehicle year/make/model/style endpoints to populate Year, Make, Model, and Style dropdowns
b. On /styles/ endpoint, note gid of the selected trim
c. Postman Example:AccuTrade Perseus API > Vehicle by YMMTBy Best Match:
a. Use vehicle search endpoint to retrieve the best matching AccuTrade vehicle
b. Note gid in response
c. Please note that the best matching vehicle will not always be accurate
d. Postman Example:AccuTrade Perseus API > Vehicle by Match
Once an AccuTrade vehicle is selected you can retrieve specific options for the vehicle.
(2) Load Vehicle Specifics
// brief description of the important parts in the vehicle data by-gid response
{
"source": 1, // this is saved to Offer.vehicle_source
"gid": 123456, // this is saved to Offer.vehicle_source_id
"year": 2022, // this is saved to Offer.vehicle_year
"make": "string", // this is saved to Offer.vehicle_make
"model": "string", // this is saved to Offer.vehicle_model
"style": "string", // this is saved to Offer.vehicle_style
"standard_equipment": "string", // description of vehicle features that are standard to the vehicle
"options": [ // value impacting options that may be associated with the vehicle
{
"ref_id": 0, // saved to OfferVac.ref_id
"description": "string", // option description, saved to OfferVac.description
"addded": "A", // A for add or D for deduct, saved to OfferVac.addded
"selected": false, // boolean indication of if we know this option is included with the vehicle, if true then OfferVac.selected must be true
"mutex": [], // mutually exclusive - if this option is selected than any option id in this array should not be selected
"disabled": false // option disabled - if this option is disabled than do not allow toggling in user interface
}
],
"specialized": false // a specialized vehicle does not have AccuTrade pricing but can still go through the system
}
Using the gid from the Vehicle Details step, supply the gid to the vehicle data by-gid endpoint to retrieve vehicle details.
Save this data - specifically the options as those are used to help accurately valuate the vehicle.
With the AccuTrade vehicle selected and its specific data loaded it is now time to perform a valuation.
(3a) Vehicle Value Estimate
Using the gid from the Vehicle Details step, supply the gid to the pricing endpoint to retrieve the vehicle value estimate.
{
// minimum required data for value estimate
"vehicle_source": 1, // from vehicle data by-gid response.source
"vehicle_source_id": 123456, // from vehicle data by-gid response.gid
"vehicle_year": 2022, // from vehicle data by-gid response.year
"vehicle_make": "string", // from vehicle data by-gid response.make
"vehicle_model": "string", // from vehicle data by-gid response.model
"vehicle_style": "string", // from vehicle data by-gid response.style
// recommended minimum data for value estimate
"vehicle_vin": "string", // user provided VIN if available
"vehicle_color": 3, // color id from /api/misc/color/
"vehicle_color_interior": 20, // color id from /api/misc/color/interior/
"vacs": [{ // data from vehicle data by-gid response.options
"description": "string", // data from vehicle data by-gid response.options option.description
"addded": "A", // data from vehicle data by-gid response.options option.addded
"ref_id": 0, // data from vehicle data by-gid response.options option.ref_id
"selected": true // true if the option applies or false otherwise
}, ...],
"vehicle_mileage": 123456, // user provided mileage if available
"pricing_type": "ranged", // ranged/gp - triggers different emails to the consumer with ranged price or single price
// pricing can only be calculated on the approximate_condition OR the detailed condition (warning lights, mechanical issues, aftermarket modifications, etc)
// if using detailed conditions, please do not include an approximate_condition value in the data
"approximate_condition": "good", // an approximate condition is recommended if there is no detailed condition (excellent/good/fair/poor)
"consumer": {
"postal_code": 60606 // valuation can change regionally so a postal code is recommended
},
// even more data will give a better value estimate, for example
"key_fobs": 2, // number of key fobs the vehicle has
"is_original_owner": true, // boolean indicator of consumer being original owner of vehicle
"carfax_has_bad_vhr": true, // boolean indicator of vehicle having bad vehicle history report
"has_frame_damage": true,
"has_warning_lights_engine": true,
"has_mechanical_suspension": true,
"has_modifications_stereo": true,
"has_hail_damage": true,
// and much more in the offer data schema
"is_liened": true, // the following fields store information about a loan or lease on the vehicle
"liened_type": "loan", // loan/lease are valid values
"owed_amount": 5000, // stores the total remaining loan amount
"lease_monthly_payment": null, // stores the lease monthly payment amount
"lease_number_payments": null, // stores the total remaining lease months
"lease_amount_remaining": null, // stores the total remaining lease amount
"is_interested_new_vehicle": true, // the following fields store information about the vehicle the consumer is interested in purchasing
"new_vehicle_type": "new", // new/cpo/used are valid values
"new_vehicle_year": 2024,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": 0,
"has_accident": false,
"insurance_payout_amount": 0, // if vehicle has current accident damage please provide payout amount
"has_external_damage": false,
"external_damage_amount": 0, // if vehicle has other external damage please provide damage amount
"front_tire_age": "excellent", // excellent/good/poor are valid values for tire condition
"rear_tire_age": "good",
"has_warning_lights_4x4": false, // the following fields store information about vehicle warning lights
"has_warning_lights_ac": false,
"has_warning_lights_abs": false,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": false,
"has_warning_lights_brake": false,
"has_warning_lights_suspension_fault": false,
"has_warning_lights_srs": false,
"has_warning_lights_tpms": false,
"has_warning_lights_traction_control": false,
"has_mechanical_sunroof_moonroof": false, // the following fields store information about vehicle mechanical issues
"has_mechanical_brakes": false,
"has_mechanical_engine": false,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": false,
"has_mechanical_ac": false,
"has_mechanical_oil_leak": false,
"has_mechanical_head_gasket": false,
"has_mechanical_catalytic_converter": false,
"has_mechanical_other": false,
"mechanical_other_note": "", // free text field describing other mechanical issues with the vehicle
"has_modifications_aftermarket_kit": false, // the following fields store information about vehicle aftermarket modifications
"has_modifications_exhaust": false,
"has_modifications_catalytic_converter": false,
"has_modifications_performance": false,
"has_modifications_spoiler": false,
"has_modifications_suspension_lowered": false,
"has_modifications_suspension_lifted": false,
"has_modifications_sunroof_moonroof": false,
"has_modifications_wheel": false,
"has_aftermarket_tint": false,
"has_flood_damage": false, // the following fields store information about other vehicle conditions
"has_fire_damage": false,
"was_stolen": false,
"has_unnamed_issue": false,
"other_issues_repair_cost": 0, // if there is an unnamed issue please provide estimated repair cost
"has_odor": false,
"is_salvage_title": false,
"is_rebuilt_title": false,
"consumer": { // the following fields store information about the consumer
"first_name": "John",
"last_name": "Doe",
"cell_phone": "5555555555",
"email": "test@accu-trade.com",
"postal_code": "60606",
"best_time_to_contact": "3", // valid values are 0 (Unknown), 1 (Morning), 2 (Afternoon), 3 (Evening)
"preferred_contact_method": "phone" // email/phone are valid values
},
"did_agree_to_tos": true, // boolean indicator of consumer agreeing to terms of service
"expect_transact_months": 2, // valid values are 0 (Ready to sell now), 2 (Ready to sell 2 - 6 months), 100 (Just Curious)
"partner_offer_id": "random partner offer identifier", // max length 255
"chrome_style_id": 123456, // chrome style id of the vehicle is helpful if provided
"lead_source": "leadstart_api" // indicates the offer came from an API integration
}
The more data passed in, the more accurate the value estimate will be. It is recommended to at least pass in a mileage, options, and approximate condition.
The response will include the single point estimate value and an array of the lower and upper estimates range.
Postman Example: AccuTrade Perseus API > Vehicle Valuation Only > 1 - Get Vehicle Price Range
(3b) Guaranteed Vehicle Valuation (Multi-Step)
The multi-step guaranteed vehicle valuation is the traditional flow used by our iframe where the user is presented with questions and the offer is updated as they proceed through the flow. When they get to the end, the offer is processed into a finalized state which sends it to the AccuTrade Appraiser and other lead configurations for the dealer. If all offer data is known ahead of time, there is no need to use the multi-step flow and instead its recommended to use the single-step flow.
The steps to build a multi-step guaranteed vehicle valuation include:
- Create offer
- Update offer
- Update consumer
- Complete offer
- View offer
Create an initial offer by submitting a POST request to the offer endpoint
Use PATCH to the offer endpoint to update offer info.
Use PATCH to the consumer endpoint to update consumer info.
At any point, to view the current vehicle valuation without performing an offer update, submit the offer payload to the pricing endpoint.
When the offer data is completed, call the offer process endpoint with a POST (empty payload is fine). This will trigger the lead sending feature to advance the offer and send it to AccuTrade’s Appraiser application. The response is the payload of the finalized offer (complete with pricing data).
As an alternative to the offer process endpoint, two APIs can be called to get the completed offer more quickly.
First call the complete offer to finalize pricing and complete the offer. You are now free to show the finalized offer to the consumer, etc.
At any point later call the push offer to actually send it to the AccuTrade Appraiser and other dealer lead configurations.
To make it even faster you can call the complete offer endpoint with push_async: true as the body and skip the "push offer" step.
Finally, after the offer has been finalized, call the offer results endpoint with a GET to retrieve the final offer details.
Postman Example: AccuTrade Perseus API > Vehicle Valuation via Offer (Multi-Step) > 1 - Create an Offer etc
(3c) Guaranteed Vehicle Valuation (Single-Step)
If all data for the offer is available right away the offer can be created and completed in one step.
{
// minimum required data for offer valuation
"vehicle_source": 1, // from vehicle data by-gid response.source
"vehicle_source_id": 123456, // from vehicle data by-gid response.gid
"vehicle_year": 2022, // from vehicle data by-gid response.year
"vehicle_make": "string", // from vehicle data by-gid response.make
"vehicle_model": "string", // from vehicle data by-gid response.model
"vehicle_style": "string", // from vehicle data by-gid response.style
// recommended minimum data for offer valuation
"vehicle_vin": "string", // user provided VIN if available
"vehicle_color": 3, // color id from /api/misc/color/
"vehicle_color_interior": 20, // color id from /api/misc/color/interior/
"vacs": [{ // data from vehicle data by-gid response.options
"description": "string", // data from vehicle data by-gid response.options option.description
"addded": "A", // data from vehicle data by-gid response.options option.addded
"ref_id": 0, // data from vehicle data by-gid response.options option.ref_id
"selected": true // true if the option applies or false otherwise
}, ...],
"vehicle_mileage": 123456, // user provided mileage if available
"pricing_type": "ranged", // ranged/gp - triggers different emails to the consumer with ranged price or single price
// pricing can only be calculated on the approximate_condition OR the detailed condition (warning lights, mechanical issues, aftermarket modifications, etc)
// if using detailed conditions, please do not include an approximate_condition value in the data
"approximate_condition": "good", // an approximate condition is recommended if there is no detailed condition (excellent/good/fair/poor)
"consumer": {
"first_name": "John",
"last_name": "Doe",
"email": "test@accu-trade.com",
"phone": "5555555555",
"postal_code": 60606 // valuation can change regionally so a postal code is recommended
},
// even more data will give a better value estimate, for example
"key_fobs": 2, // number of key fobs the vehicle has
"is_original_owner": true, // boolean indicator of consumer being original owner of vehicle
"carfax_has_bad_vhr": true, // boolean indicator of vehicle having bad vehicle history report
"has_frame_damage": true,
"has_warning_lights_engine": true,
"has_mechanical_suspension": true,
"has_modifications_stereo": true,
"has_hail_damage": true,
// and much more in the offer data schema
"is_liened": true, // the following fields store information about a loan or lease on the vehicle
"liened_type": "loan", // loan/lease are valid values
"owed_amount": 5000, // stores the total remaining loan amount
"lease_monthly_payment": null, // stores the lease monthly payment amount
"lease_number_payments": null, // stores the total remaining lease months
"lease_amount_remaining": null, // stores the total remaining lease amount
"is_interested_new_vehicle": true, // the following fields store information about the vehicle the consumer is interested in purchasing
"new_vehicle_type": "new", // new/cpo/used are valid values
"new_vehicle_year": 2024,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": 0,
"has_accident": false,
"insurance_payout_amount": 0, // if vehicle has current accident damage please provide payout amount
"has_external_damage": false,
"external_damage_amount": 0, // if vehicle has other external damage please provide damage amount
"front_tire_age": "excellent", // excellent/good/poor are valid values for tire condition
"rear_tire_age": "good",
"has_warning_lights_4x4": false, // the following fields store information about vehicle warning lights
"has_warning_lights_ac": false,
"has_warning_lights_abs": false,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": false,
"has_warning_lights_brake": false,
"has_warning_lights_suspension_fault": false,
"has_warning_lights_srs": false,
"has_warning_lights_tpms": false,
"has_warning_lights_traction_control": false,
"has_mechanical_sunroof_moonroof": false, // the following fields store information about vehicle mechanical issues
"has_mechanical_brakes": false,
"has_mechanical_engine": false,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": false,
"has_mechanical_ac": false,
"has_mechanical_oil_leak": false,
"has_mechanical_head_gasket": false,
"has_mechanical_catalytic_converter": false,
"has_mechanical_other": false,
"mechanical_other_note": "", // free text field describing other mechanical issues with the vehicle
"has_modifications_aftermarket_kit": false, // the following fields store information about vehicle aftermarket modifications
"has_modifications_exhaust": false,
"has_modifications_catalytic_converter": false,
"has_modifications_performance": false,
"has_modifications_spoiler": false,
"has_modifications_suspension_lowered": false,
"has_modifications_suspension_lifted": false,
"has_modifications_sunroof_moonroof": false,
"has_modifications_wheel": false,
"has_aftermarket_tint": false,
"has_flood_damage": false, // the following fields store information about other vehicle conditions
"has_fire_damage": false,
"was_stolen": false,
"has_unnamed_issue": false,
"other_issues_repair_cost": 0, // if there is an unnamed issue please provide estimated repair cost
"has_odor": false,
"is_salvage_title": false,
"is_rebuilt_title": false,
"consumer": { // the following fields store information about the consumer
"first_name": "John",
"last_name": "Doe",
"cell_phone": "5555555555",
"email": "test@accu-trade.com",
"postal_code": "60606",
"best_time_to_contact": "3", // valid values are 0 (Unknown), 1 (Morning), 2 (Afternoon), 3 (Evening)
"preferred_contact_method": "phone" // email/phone are valid values
},
"did_agree_to_tos": true, // boolean indicator of consumer agreeing to terms of service
"expect_transact_months": 2, // valid values are 0 (Ready to sell now), 2 (Ready to sell 2 - 6 months), 100 (Just Curious)
"partner_offer_id": "random partner offer identifier", // max length 255
"chrome_style_id": 123456, // chrome style id of the vehicle is helpful if provided
"lead_source": "leadstart_api", // indicates the offer came from an API integration
"push_async": false // include push_async: true if a faster response is needed
}
Make a call including all offer and consumer data that is available to the to abbreviated offer endpoint.
This endpoint effectively combines almost all of the multi-step endpoints into one.
If you include push_async: true in the abbreviated offer body the endpoint will perform faster.
You may still call the offer results endpoint to get the final offer details.
Postman Example: AccuTrade Perseus API > Vehicle Valuation via Offer (Single-Step) > Create and Finalize an Offer
Refresh Offers
Offers are valid for 3 days. Once they expire they can be refreshed with the refresh offer endpoint.
No input is required, however, any data passed will update the offer before calculating the latest pricing.
If you include push_async: true in the refresh offer body the endpoint will perform faster.
Postman Example: AccuTrade Perseus API > Miscellaneous > Refresh Offer
API URLs
Pre-Production URLs:
Base URLs:
Authentication
- API Key (api_key)
- Parameter Name: Authorization, in: header.
algol
Create a lease
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/algol/create_lease/', headers = headers)
print(r.json())
const inputBody = '{
"lease_company": "string",
"end_date": "2019-08-24",
"loan_id": "string",
"vin": "stringstringstrin",
"trim": "string",
"options": [
{
"name": "string",
"selected": false
}
],
"offer": {
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"index": -2147483648,
"name": "string",
"hex_code": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"index": -2147483648,
"name": "string",
"hex_code": "string",
"ref_id": -2147483648
},
"dealer": {
"preferences": {
"partner_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"show_language_switch": true,
"language_switch": "menu",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"enable_dsa_consumer_exclude_states": true,
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"ab_testing": {},
"consumer_env_base_url": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"user": {
"last_login": "2019-08-24T14:15:22Z",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true
},
"source_system": {
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"loan_payoff": 0,
"loan_equity": 0,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_photos": [
0
]
},
"first_name": "string",
"email": "user@example.com"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/algol/create_lease/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/algol/create_lease/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /algol/create_lease/
Create a lease
Body parameter
{
"lease_company": "string",
"end_date": "2019-08-24",
"loan_id": "string",
"vin": "stringstringstrin",
"trim": "string",
"options": [
{
"name": "string",
"selected": false
}
],
"offer": {
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"index": -2147483648,
"name": "string",
"hex_code": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"index": -2147483648,
"name": "string",
"hex_code": "string",
"ref_id": -2147483648
},
"dealer": {
"preferences": {
"partner_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"show_language_switch": true,
"language_switch": "menu",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"enable_dsa_consumer_exclude_states": true,
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"ab_testing": {},
"consumer_env_base_url": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"user": {
"last_login": "2019-08-24T14:15:22Z",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true
},
"source_system": {
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"loan_payoff": 0,
"loan_equity": 0,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_photos": [
0
]
},
"first_name": "string",
"email": "user@example.com"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ALGolLease | true | none |
Example responses
201 Response
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"lease_company": "string",
"end_date": "2019-08-24",
"loan_id": "string",
"vin": "stringstringstrin",
"trim": "string",
"options": [
{
"name": "string",
"selected": false
}
],
"offer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"dealer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"original_range": "string",
"boosted_offer_range_low": 0,
"boosted_offer_range_high": 0,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
],
"loan_payoff": 0,
"loan_equity": 0,
"has_uploaded_photo_incentive": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
},
"first_name": "string",
"email": "user@example.com",
"messages": [
{
"id": 0,
"sender_type": "string",
"sender": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"message": "string",
"sender_role": 1,
"sender_name": "string",
"sender_phone": "string",
"sender_image": "string",
"amount": 0,
"offer": 0,
"sender_dealer": 0,
"sender_system": 0
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | ALGolLease |
Import lease data
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/algol/import_data/', headers = headers)
print(r.json())
const inputBody = '{
"lease_company": "string",
"dry_run": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/algol/import_data/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/algol/import_data/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /algol/import_data/
Import lease data
Body parameter
{
"lease_company": "string",
"dry_run": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ALGolLeaseCSVUpload | true | none |
Example responses
201 Response
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"lease_company": "string",
"csv_file": "http://example.com",
"dry_run": true,
"status": 0,
"result": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | ALGolLeaseCSVUpload |
Retrieve lease data import status
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/algol/import_data/{uuid}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/algol/import_data/{uuid}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/algol/import_data/{uuid}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /algol/import_data/{uuid}/
Retrieve lease data import status
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | true | none |
Example responses
200 Response
[
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"lease_company": "string",
"csv_file": "http://example.com",
"dry_run": true,
"status": 0,
"result": {}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ALGolLeaseCSVUpload] | false | none | none |
| » uuid | string(uuid) | false | read-only | none |
| » lease_company | string | true | none | none |
| » csv_file | string(uri) | false | read-only | none |
| » dry_run | boolean | false | none | none |
| » status | integer | false | read-only | none |
| » result | object | false | read-only | none |
Retrieve lease data import CSV
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/algol/import_data/{uuid}/csv/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/algol/import_data/{uuid}/csv/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/algol/import_data/{uuid}/csv/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /algol/import_data/{uuid}/csv/
Retrieve lease data import CSV
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| uuid | path | string | true | none |
Example responses
200 Response
[
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"lease_company": "string",
"csv_file": "http://example.com",
"dry_run": true,
"status": 0,
"result": {}
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ALGolLeaseCSVUpload] | false | none | none |
| » uuid | string(uuid) | false | read-only | none |
| » lease_company | string | true | none | none |
| » csv_file | string(uri) | false | read-only | none |
| » dry_run | boolean | false | none | none |
| » status | integer | false | read-only | none |
| » result | object | false | read-only | none |
common
Retrieve a VIN number by license plate and state
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/common/plate-to-vin/{country}/{state}/{number}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/common/plate-to-vin/{country}/{state}/{number}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/common/plate-to-vin/{country}/{state}/{number}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /common/plate-to-vin/{country}/{state}/{number}/
Retrieve a VIN number by license plate and state. The only supported country is US. Returns a list of possible VIN numbers.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| country | path | string | true | none |
| state | path | string | true | none |
| number | path | string | true | none |
Example responses
Possible VIN numbers
[
"string"
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Possible VIN numbers | None |
| 400 | Bad Request | Invalid parameters | None |
Response Schema
contentpiece
Retrieve a list of all default English content pieces
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/contentpiece/default_en/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/contentpiece/default_en/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/contentpiece/default_en/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /contentpiece/default_en/
Retrieve a list of all default English content pieces
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| search | query | string | false | A search term. |
Example responses
200 Response
[
{
"id": 0,
"key": "string",
"value": "string",
"default": false,
"language": "en",
"label": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"configuration": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ContentPiece] | false | none | none |
| » id | integer | false | read-only | none |
| » key | string | true | none | none |
| » value | string | false | none | none |
| » default | boolean | false | none | none |
| » language | string | false | none | none |
| » label | string¦null | false | none | none |
| » created | string(date-time) | false | read-only | none |
| » modified | string(date-time) | false | read-only | none |
| » configuration | integer¦null | true | none | none |
Retrieve a list of all default content pieces for a language/partner/country
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/contentpiece/defaults/{language}/{partner_identifier}/{country_code}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/contentpiece/defaults/{language}/{partner_identifier}/{country_code}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/contentpiece/defaults/{language}/{partner_identifier}/{country_code}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /contentpiece/defaults/{language}/{partner_identifier}/{country_code}/
Retrieve a list of all default content pieces for a language/partner/country
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| search | query | string | false | A search term. |
| language | path | string | true | none |
| partner_identifier | path | string | true | none |
| country_code | path | string | true | none |
Example responses
200 Response
[
{
"id": 0,
"key": "string",
"value": "string",
"default": false,
"language": "en",
"label": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"configuration": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ContentPiece] | false | none | none |
| » id | integer | false | read-only | none |
| » key | string | true | none | none |
| » value | string | false | none | none |
| » default | boolean | false | none | none |
| » language | string | false | none | none |
| » label | string¦null | false | none | none |
| » created | string(date-time) | false | read-only | none |
| » modified | string(date-time) | false | read-only | none |
| » configuration | integer¦null | true | none | none |
equity
Retrieve list of lenders
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/equity/lenders/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/equity/lenders/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/equity/lenders/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /equity/lenders/
Retrieve list of lenders
Example responses
200 Response
[
{
"name": "string",
"lender_id": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Lender] | false | none | none |
| » name | string | true | none | none |
| » lender_id | string | true | none | none |
geo
Retrieve a list of all countries
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/geo/country/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/geo/country/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/geo/country/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /geo/country/
Retrieve a list of all countries. Default ordering is alphabetically by name.
Example responses
200 Response
[
{
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Country] | false | none | none |
| » id | integer | false | read-only | none |
| » name | string | true | none | none |
| » short_name | string | true | none | none |
| » slug | string(slug) | false | read-only | none |
Retrieve postal code by coordinates
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/geo/postal/get_by_coords/', params={
'latitude': '0', 'longitude': '0'
}, headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/geo/postal/get_by_coords/?latitude=0&longitude=0',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/geo/postal/get_by_coords/?latitude=0&longitude=0 \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /geo/postal/get_by_coords/
Retrieve postal code by coordinates
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| latitude | query | number(decimal) | true | none |
| longitude | query | number(decimal) | true | none |
Example responses
200 Response
{
"postal_code": "string",
"state": {
"id": 0,
"country": {
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
},
"name": "string",
"short_name": "st",
"slug": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PostalCode |
| 404 | Not Found | No location found | None |
Retrieve a list of all states
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/geo/state/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/geo/state/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/geo/state/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /geo/state/
Retrieve a list of all states. Default ordering is alphabetically by name.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ordering | query | string | false | Which field to use when ordering the results. |
Example responses
200 Response
[
{
"id": 0,
"country": {
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
},
"name": "string",
"short_name": "st",
"slug": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [State] | false | none | none |
| » id | integer | false | read-only | none |
| » country | Country | true | none | none |
| »» id | integer | false | read-only | none |
| »» name | string | true | none | none |
| »» short_name | string | true | none | none |
| »» slug | string(slug) | false | read-only | none |
| » name | string | true | none | none |
| » short_name | string | true | none | none |
| » slug | string(slug) | false | read-only | none |
Retrieve state by request IP address
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/geo/state/get_by_ip/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/geo/state/get_by_ip/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/geo/state/get_by_ip/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /geo/state/get_by_ip/
Retrieve state by request IP address
Example responses
200 Response
{
"id": 0,
"country": {
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
},
"name": "string",
"short_name": "st",
"slug": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | State |
| 404 | Not Found | No state found | None |
member
Validate consumer data
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/member/consumer/validate/', headers = headers)
print(r.json())
const inputBody = '{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/consumer/validate/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/member/consumer/validate/ \
-H 'Content-Type: application/json' \
-H 'Authorization: Token API_KEY'
POST /member/consumer/validate/
Validate consumer data
Body parameter
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ConsumerValidation | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Valid data | None |
| 400 | Bad Request | Invalid data | None |
Retrieve a dealership by partners dealer id
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/member/dealer/by-partner-id/{partner_id}/{dealer_id}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/dealer/by-partner-id/{partner_id}/{dealer_id}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/member/dealer/by-partner-id/{partner_id}/{dealer_id}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /member/dealer/by-partner-id/{partner_id}/{dealer_id}/
Retrieve a dealership by partners dealer id
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| partner_id | path | string | true | none |
| dealer_id | path | string | true | none |
Example responses
200 Response
[
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Dealership] | false | none | none |
| » id | integer | false | read-only | none |
| » archived | string(date-time) | false | read-only | none |
| » preferences | Preferences | false | none | none |
| »» id | integer | false | read-only | none |
| »» partner_identifier | string | false | none | none |
| »» branding_identifier | string | false | read-only | none |
| »» pricing_country | string | false | none | Enum Description: usa - United States canada - Canada |
| »» single_page_workflow | boolean | false | none | Deprecated, use digital_retail_experience and ranged_or_gp instead |
| »» combined_details_conditions_page | boolean | false | none | none |
| »» digital_retail_experience | boolean | false | none | none |
| »» digital_retail_uuid_configs | boolean | false | none | If dealer uuid/vdpid/odid specified when loading preferences then prefer dealer preferences over system |
| »» show_pii_for_digital_retail | boolean | false | none | none |
| »» hide_digital_retail_offer_page | boolean | false | none | none |
| »» root_branding_enabled | boolean | false | none | none |
| »» accu_trade_appraiser | boolean¦null | false | none | Deprecated, should be True |
| »» ranged_or_gp | string¦null | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price disabled - Disabled ranged_and_gp - Ranged and Guaranteed Price ymmt_gp - YMMT Guaranteed Price single_page_ranged - Single Page Ranged |
| »» vin_to_value_enabled | boolean | false | none | none |
| »» autocheck_vhr_disabled | boolean | false | none | none |
| »» autocheck_hide_questions | boolean | false | none | Hides consumer flow questions if autocheck data answers them |
| »» pricing_boost_to_market | boolean | false | none | none |
| »» voi_required | boolean | false | none | none |
| »» show_oem_gtp | integer¦null | false | none | Enum Description: 1 - Higher 2 - Always |
| »» bypass_no_value_check | boolean | false | none | none |
| »» low_value_dealer_review | boolean | false | none | none |
| »» combined_dcp_enabled | boolean | false | none | Combined details/conditions/prospect pages, aka hybrid vin-to-value |
| »» combined_dcp_simplified_header | boolean | false | none | none |
| »» enable_condensed_conditions | boolean | false | none | none |
| »» show_dealer_group_dropdown | boolean¦null | false | none | none |
| »» dsa_lookup_type | string | false | none | Enum Description: voi - VOI |
| »» preferred_language | string | false | read-only | none |
| »» supported_languages | [string] | false | read-only | none |
| »» show_language_switch | boolean | false | none | Deprecated, use language_switch |
| »» language_switch | string¦null | false | none | Enum Description: menu - Menu inline - Inline |
| »» content_pieces | string | false | read-only | none |
| »» tax_discount | number(decimal) | false | none | none |
| »» google_tracker | string | false | none | none |
| »» google_conversion | string | false | none | none |
| »» google_conversion_id | string | false | none | none |
| »» google_conversion_label | string | false | none | none |
| »» google_conversion_id_consumer_engagement | string | false | none | none |
| »» google_conversion_label_consumer_engagement | string | false | none | none |
| »» google_tag_manager_id | string¦null | false | none | none |
| »» has_ga4_measurement_config | string | false | read-only | none |
| »» ga4_measurement_ids | object | false | none | none |
| »» enable_send_to | boolean | false | none | none |
| »» offer_view_base_url | string¦null | false | none | none |
| »» appointment_email | string(email) | false | none | none |
| »» appointment_contact | string | false | none | none |
| »» advanced_offer_lead_selection | boolean | false | none | Deprecated, always on for DSA systems |
| »» dsa_enabled | string | false | read-only | none |
| »» is_utf7 | boolean¦null | false | none | none |
| »» crm_leads | [CRMLead] | true | none | none |
| »»» id | integer | false | none | none |
| »»» type | string | false | none | none |
| »»» format | string | true | none | none |
| »»» target | string | true | none | none |
| »»» lead_source | string¦null | false | none | none |
| »»» lead_source_types | [string]¦null | false | none | none |
| string(email) | false | none | none | |
| »»» phone | string | false | none | none |
| »»» api_url | string(uri)¦null | false | none | none |
| »»» api_data | object | false | none | none |
| »»» name | string | false | none | none |
| »»» lead_source_type | string¦null | false | none | Enum Description: dsa - DSA - 3rd Party Website dr3 - Digital Retail - 3rd Party Website dr1 - Digital Retail - Dealers Website dww - Widget - Dealers Website driveway - Widget - Dealers Website - Driveway Appraisal campaign - Widget - Dealers Website - Campaign |
| »»» lead_identifier | string¦null | false | none | none |
| »»» descriptor | string | false | none | none |
| »»» provider | string¦null | false | none | Overrides ADF provider name tag |
| »»» provider_service | string¦null | false | none | Overrides ADF provider service tag |
| »» facilitation_location | FacilitationLocation | true | none | none |
| »»» id | integer | false | read-only | none |
| »»» name | string | true | none | none |
| »»» address1 | string¦null | false | none | none |
| »»» address2 | string¦null | false | none | none |
| »»» city | string¦null | false | none | none |
| »»» state | string¦null | false | none | none |
| »»» postal_code | string¦null | false | none | none |
| »»» contact | string | false | none | none |
| »»» instructions | string | false | none | none |
| »» replacement_vehicle | boolean¦null | false | none | none |
| »» show_new | boolean¦null | false | none | none |
| »» show_used | boolean¦null | false | none | none |
| »» show_cpo | boolean¦null | false | none | none |
| »» replacement_vehicle_makes | string | false | read-only | none |
| »» voi_trim_required | string | false | read-only | none |
| »» consumer_offer_expiration_period | integer | false | none | none |
| »» dealer_offer_expiration_period | integer | false | none | none |
| »» banner_url | string¦null | false | none | none |
| »» mobile_banner_url | string¦null | false | none | none |
| »» logo_url | string¦null | false | none | none |
| »» logo_url_driveway | string¦null | false | none | none |
| »» vehicle_entry_default | string | false | none | Enum Description: licensePlate - Plate vin - VIN ymmt - YMMT |
| »» deemphasize_vehicle_entry_ymmt | boolean | false | none | none |
| »» vehicle_entry_selector_shape | string | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| »» color_selector_shape | string¦null | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| »» cta_button_shape | string | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| »» option_button_shape | string¦null | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| »» hide_original_owner | boolean | false | none | none |
| »» hide_zip_code_field | boolean | false | none | none |
| »» hide_zip_code_field_on_pii | boolean | false | none | none |
| »» enable_geolocation | boolean | false | none | none |
| »» enable_advanced_color_selector | boolean | false | none | none |
| »» hide_vehicle_color_selector | boolean | false | none | none |
| »» hide_interior_color_selector | boolean | false | none | none |
| »» hide_vin_field | boolean | false | none | none |
| »» show_tax_savings_on_pii_page | boolean | false | none | none |
| »» suppress_address | boolean | false | none | none |
| »» expand_offer_condition_details | boolean | false | none | none |
| »» hide_offer_tax_savings | boolean | false | none | none |
| »» incorporate_tax_savings | boolean | false | none | none |
| »» hide_offer_breakdown | boolean | false | none | none |
| »» hide_offer_next_steps | boolean | false | none | none |
| »» hide_offer_dealer_contact_section | boolean | false | none | none |
| »» hide_vehicle_estimate_header | boolean | false | none | none |
| »» vehicle_estimate_header_text_color | string¦null | false | none | none |
| »» hide_footer | boolean | false | none | none |
| »» hide_how_it_works | boolean | false | none | none |
| »» hide_home_header | boolean | false | none | none |
| »» hide_header_price_during_survey | boolean | false | none | none |
| »» show_header_video | boolean | false | none | none |
| »» show_system_alert | boolean | false | none | none |
| »» show_estimate_condition | boolean | false | none | none |
| »» show_estimate_cell_phone | boolean | false | none | none |
| »» hide_estimate_original_owner | boolean | false | none | none |
| »» estimate_replacement_vehicle | boolean | false | none | none |
| »» hide_plate_to_vin | boolean | false | none | none |
| »» plate_to_vin_state_geolocation | boolean | false | none | none |
| »» show_keys_question | boolean | false | none | none |
| »» show_estimate_is_liened | boolean | false | none | none |
| »» show_gp_is_liened | boolean | false | none | none |
| »» show_gp_cell_phone | boolean | false | none | none |
| »» hide_gp_ymmt_fields | boolean | false | none | none |
| »» hide_pii_step | boolean | false | none | none |
| »» hide_last_name_field | boolean | false | none | none |
| »» hide_email_field | boolean | false | none | none |
| »» show_member_identifier | boolean | false | none | none |
| »» show_expected_transaction | boolean | false | none | none |
| »» show_best_time_to_contact | boolean | false | none | none |
| »» show_notes_entry | boolean | false | none | none |
| »» show_phone_verification | boolean | false | none | none |
| »» show_photo_upload_on_offer | boolean | false | none | none |
| »» show_estimate_photo_upload_on_offer | boolean | false | none | none |
| »» expand_photo_upload_on_offer | boolean | false | none | none |
| »» enable_photo_guidance | boolean | false | none | none |
| »» show_optional_photos | boolean | false | none | none |
| »» optional_photos_required | boolean | false | none | none |
| »» optional_photos_location | string | false | none | Enum Description: vehicle-details-top - Vehicle details top vehicle-details-bottom - Vehicle details bottom |
| »» assumptions_location | string | false | none | Enum Description: top - Top bottom - Bottom |
| »» enable_editable_assumptions | boolean | false | none | none |
| »» show_price_review | boolean | false | none | none |
| »» price_review_sequencing | string | false | none | Enum Description: high - High low - Low |
| »» show_comparable_vehicles | boolean | false | none | none |
| »» hide_comparable_vehicles_spread_table | boolean | false | none | none |
| »» comparable_vehicles_display | string | false | none | Enum Description: both - Both graph - Graph map - Map list - List |
| »» comparable_vehicles_displays | [string] | true | none | none |
| »» comparable_vehicles_summary | string | false | none | Enum Description: both - Both text - Text |
| »» show_equity_payout_on_offer | boolean | false | none | none |
| »» show_equity_payout_on_detail | boolean | false | none | none |
| »» show_single_value_offer_estimate | boolean | false | none | none |
| »» offer_header | string | false | none | Enum Description: original - Original alt-a - Alternative A |
| »» offer_ready_to_sell | string | false | none | Enum Description: original - Original alt-a - Alternative A |
| »» offer_ready_alt_background_color | string¦null | false | none | none |
| »» offer_ready_alt_text_color | string¦null | false | none | none |
| »» offer_ready_alt_primary_button_color | string¦null | false | none | none |
| »» offer_ready_alt_primary_button_text_color | string¦null | false | none | none |
| »» offer_ready_alt_secondary_button_color | string¦null | false | none | none |
| »» offer_ready_alt_secondary_button_text_color | string¦null | false | none | none |
| »» offer_ready_alt_secondary_button_border_color | string¦null | false | none | none |
| »» use_submitted_vehicle_image | boolean | false | none | none |
| »» should_send_to_showroom_leads | boolean | false | none | none |
| »» cell_phone_optional | boolean | false | none | none |
| »» show_branded_banner | boolean | false | none | none |
| »» show_confirmation_hero | boolean | false | none | none |
| »» hide_contact_cta_on_offer | boolean | false | none | none |
| »» show_offer_html_block | boolean | false | none | none |
| »» hide_vin_field_on_registration | boolean | false | none | none |
| »» enable_context_price_display | boolean | false | none | none |
| »» disable_focus_outline | boolean | false | none | none |
| »» focus_outline_color | string¦null | false | none | none |
| »» disable_page_change_scroll | boolean | false | none | none |
| »» page_change_scroll_offset_desktop | integer¦null | false | none | none |
| »» page_change_scroll_offset_mobile | integer¦null | false | none | none |
| »» disable_history_state | boolean¦null | false | none | none |
| »» widget_enable_host_tracking | boolean | false | none | none |
| »» banner_color | string¦null | false | none | none |
| »» cert_banner_color | string¦null | false | none | none |
| »» cert_compare_background_color | string¦null | false | none | none |
| »» cert_summary_background_color | string¦null | false | none | none |
| »» cert_summary_text_color | string¦null | false | none | none |
| »» cert_summary_separator_color | string¦null | false | none | none |
| »» default_text_color | string¦null | false | none | none |
| »» deemphasized_text_color | string¦null | false | none | none |
| »» heading_text_color | string¦null | false | none | none |
| »» footer_background_color | string¦null | false | none | none |
| »» footer_text_color | string¦null | false | none | none |
| »» footer_link_color | string¦null | false | none | none |
| »» link_color | string¦null | false | none | none |
| »» vehicle_entry_selector_border_color | string¦null | false | none | none |
| »» vehicle_entry_selector_button_fill_color | string¦null | false | none | none |
| »» vehicle_entry_selector_text_color | string¦null | false | none | none |
| »» vehicle_entry_selector_selected_text_color | string¦null | false | none | none |
| »» enable_ymmt_column_layout | boolean | false | none | none |
| »» enable_alt_trim_selection | boolean | false | none | none |
| »» option_selection_color | string¦null | false | none | none |
| »» option_button_text_color | string¦null | false | none | none |
| »» option_button_selected_text_color | string¦null | false | none | none |
| »» option_button_unselected_border_color | string¦null | false | none | none |
| »» primary_button_background_color | string¦null | false | none | none |
| »» primary_button_text_color | string¦null | false | none | none |
| »» secondary_button_background_color | string¦null | false | none | none |
| »» secondary_button_text_color | string¦null | false | none | none |
| »» secondary_button_border_color | string¦null | false | none | none |
| »» separator_color | string¦null | false | none | none |
| »» primary_header_text_color | string¦null | false | none | none |
| »» step_info_header_background_color | string¦null | false | none | none |
| »» step_info_header_text_color | string¦null | false | none | none |
| »» section_background_color | string¦null | false | none | none |
| »» autocheck_message_text_color | string¦null | false | none | none |
| »» autocheck_message_background_color | string¦null | false | none | none |
| »» autocheck_message_border_color | string¦null | false | none | none |
| »» autocheck_warn_background_color | string¦null | false | none | none |
| »» autocheck_warn_icon_color | string¦null | false | none | none |
| »» tab_color | string¦null | false | none | none |
| »» tab_separator_color | string¦null | false | none | none |
| »» details_conditions_separator_color | string¦null | false | none | none |
| »» form_field_placeholder_color | string¦null | false | none | none |
| »» form_field_title_color | string¦null | false | none | none |
| »» form_field_text_color | string¦null | false | none | none |
| »» form_field_border_color | string¦null | false | none | none |
| »» negative_value_color | string¦null | false | none | none |
| »» positive_value_color | string¦null | false | none | none |
| »» form_checkbox_color | string¦null | false | none | none |
| »» form_checkbox_unselected_color | string¦null | false | none | none |
| »» offer_condition_label_color | string¦null | false | none | none |
| »» offer_condition_value_color | string¦null | false | none | none |
| »» widget_google_font_import | string | false | none | none |
| »» font_family | string¦null | false | none | none |
| »» widget_banner_hide_logo | boolean | false | none | none |
| »» widget_drawer_hide_logo | boolean | false | none | none |
| »» typeahead_widget_banner_color | string¦null | false | none | none |
| »» typeahead_widget_banner_font_color | string¦null | false | none | none |
| »» typeahead_widget_banner_font_family | string¦null | false | none | none |
| »» typeahead_widget_banner_font_size | string¦null | false | none | none |
| »» typeahead_widget_banner_height | integer¦null | false | none | none |
| »» typeahead_widget_banner_mobile_height | integer¦null | false | none | none |
| »» typeahead_widget_banner_background | string | false | none | none |
| »» typeahead_widget_banner_mobile_background | string | false | none | none |
| »» typeahead_drawer_color | string¦null | false | none | none |
| »» typeahead_drawer_font_color | string¦null | false | none | none |
| »» typeahead_drawer_font_family | string¦null | false | none | none |
| »» typeahead_drawer_font_size | string¦null | false | none | none |
| »» typeahead_drawer_handle_color | string¦null | false | none | none |
| »» typeahead_drawer_handle_text_color | string¦null | false | none | none |
| »» typeahead_widget_drawer_handle_height | integer¦null | false | none | none |
| »» typeahead_widget_drawer_handle_position | string¦null | false | none | Enum Description: left - Left center - Center right - Right |
| »» typeahead_drawer_force_ontop | boolean | false | none | none |
| »» typeahead_hero_color | string¦null | false | none | none |
| »» typeahead_hero_font_color | string¦null | false | none | none |
| »» typeahead_hero_font_family | string¦null | false | none | none |
| »» typeahead_hero_font_size | string¦null | false | none | none |
| »» typeahead_widget_hero_banner_color | string¦null | false | none | none |
| »» typeahead_widget_hero_banner_text_color | string¦null | false | none | none |
| »» show_uploaded_photo_incentive | boolean | false | none | none |
| »» photo_incentive_value | integer¦null | false | none | none |
| »» css_block | string | false | none | none |
| »» typeahead_css_block | string | false | none | none |
| »» custom_questions | object | false | none | none |
| »» facebook_pixel_id | string | false | none | none |
| »» lotame_client_id | string | false | none | none |
| »» qualtrics_zone_id | string¦null | false | none | none |
| »» qualtrics_brand_id | string¦null | false | none | none |
| »» enable_ddc_banners | boolean | false | none | none |
| »» enable_ddc_ctas | boolean | false | none | none |
| »» ddc_cta_type | string | false | none | Enum Description: default - Default primary - Primary |
| »» ddc_cta_launches_modal | boolean | false | none | none |
| »» enable_d2c_tracking | boolean | false | none | none |
| »» d2c_media_dealer_key | string¦null | false | none | none |
| »» disable_offer_missing_vin_to_consumer_email | boolean | false | none | none |
| »» disable_new_offer_to_consumer_email | boolean | false | none | none |
| »» disable_offer_no_value_to_consumer_email | boolean | false | none | none |
| »» enable_sms_offer_result_to_consumer | boolean | false | none | none |
| »» widget_domain_whitelist | [string] | true | none | none |
| »» marketplace_automation_buying | boolean¦null | false | none | none |
| »» dww_consumer_max_distance | integer¦null | false | none | none |
| »» restrict_leads_outside_service_area | boolean | false | read-only | none |
| »» dsa_consumer_max_distance | integer¦null | false | none | No value uses the DSA level limit, specifying a value will override the DSA level limit only if the specified value is smaller |
| »» enable_dsa_consumer_max_distance | boolean | false | none | none |
| »» dsa_consumer_exclude_states | [string] | false | read-only | none |
| »» enable_dsa_consumer_exclude_states | boolean | false | none | none |
| »» dsa_vehicle_exclude_makes | [string] | false | read-only | none |
| »» enable_dsa_vehicle_exclude_makes | boolean | false | none | none |
| »» dsa_vehicle_max_odometer | integer¦null | false | none | none |
| »» enable_dsa_vehicle_max_odometer | boolean | false | none | none |
| »» dsa_vehicle_offer_price_cap | integer¦null | false | none | none |
| »» enable_dsa_vehicle_offer_price_cap | boolean | false | none | none |
| »» complete_offer_push_async | boolean | false | read-only | none |
| »» ab_testing | object¦null | false | none | none |
| »» terms_and_conditions_url | string | false | read-only | none |
| »» support_phone_number | string | false | read-only | none |
| »» support_email | string | false | read-only | none |
| »» dealer_key | string | false | read-only | none |
| »» country_code | string | false | read-only | none |
| »» source_dealer_id | string | false | read-only | none |
| »» oem_name | string | false | read-only | none |
| »» oem_dealer_id | string | false | read-only | none |
| »» oem_sub_brand | string | false | read-only | none |
| »» oem_tier_id | string | false | read-only | none |
| »» oem_analytics_vendor | string | false | read-only | none |
| »» oem_analytics_id | string | false | read-only | none |
| »» oem_analytics_provider_id | string | false | read-only | none |
| »» oem_analytics_url_stage | string | false | read-only | none |
| »» oem_analytics_url_prod | string | false | read-only | none |
| »» dealership_name | string | false | read-only | none |
| »» dealership_region | string | false | read-only | none |
| »» dealership_group | string | false | read-only | none |
| »» primary_contact_phone | string | false | read-only | none |
| »» consumer_env_base_url | string | true | none | none |
| »» embed_snippet | string | false | read-only | none |
| »» typeahead_widget_embed_snippet | string | false | read-only | none |
| »» typeahead_drawer_embed_snippet | string | false | read-only | none |
| »» typeahead_hero_embed_snippet | string | false | read-only | none |
| »» typeahead_headless_embed_snippet | string | false | read-only | none |
| » partner | string | true | none | none |
| » branding | string¦null | false | none | none |
| » product | string | true | none | none |
| » company | integer | true | none | none |
| » in_partner_dsa | boolean¦null | false | read-only | none |
| » created | string(date-time) | false | read-only | none |
| » modified | string(date-time) | false | read-only | none |
| » name | string | true | none | none |
| » address1 | string¦null | false | none | none |
| » address2 | string¦null | false | none | none |
| » city | string¦null | false | none | none |
| » state | string¦null | false | none | none |
| » postal_code | string¦null | false | none | none |
| » partner_dealer_id | string¦null | true | none | none |
| » oem_name | string¦null | false | none | none |
| » oem_dealer_id | string¦null | false | none | none |
| » oem_dealer_id2 | string¦null | false | none | none |
| » oem_sub_brand | string¦null | false | none | none |
| » friendly_name | string¦null | false | none | none |
| » friendly_phone | string¦null | false | none | none |
| » primary_contact_name | string¦null | false | none | none |
| » primary_contact_phone | string¦null | false | none | none |
| » primary_contact_email | string(email) | true | none | none |
| » primary_contact_title | string | false | none | none |
| » primary_contact_image | string | false | none | none |
| » lead_primary_contact_name | string¦null | false | none | none |
| » lead_primary_contact_phone | string¦null | false | none | none |
| » lead_primary_contact_email | string¦null | false | none | none |
| » dealer_image | string | false | none | none |
| » profile_url | string | false | none | none |
| » uuid | string | false | none | none |
| » country | integer¦null | false | none | Enum Description: 1 - USA 2 - Canada |
| » source_id | string¦null | false | none | none |
| » source_type | integer¦null | false | none | none |
| » expiration_date | string(date-time)¦null | false | none | none |
| » adf_user_id | string¦null | false | none | none |
| » disable_partner_events | boolean | false | none | Disable related partner or system events when the offer is associated with this dealership |
| » user | integer¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| pricing_country | usa |
| pricing_country | canada |
| ranged_or_gp | ranged |
| ranged_or_gp | gp |
| ranged_or_gp | disabled |
| ranged_or_gp | ranged_and_gp |
| ranged_or_gp | ymmt_gp |
| ranged_or_gp | single_page_ranged |
| show_oem_gtp | 1 |
| show_oem_gtp | 2 |
| dsa_lookup_type | voi |
| language_switch | menu |
| language_switch | inline |
| lead_source_type | dsa |
| lead_source_type | dr3 |
| lead_source_type | dr1 |
| lead_source_type | dww |
| lead_source_type | driveway |
| lead_source_type | campaign |
| vehicle_entry_default | licensePlate |
| vehicle_entry_default | vin |
| vehicle_entry_default | ymmt |
| vehicle_entry_selector_shape | rounded |
| vehicle_entry_selector_shape | square |
| vehicle_entry_selector_shape | underline |
| color_selector_shape | rounded |
| color_selector_shape | square |
| color_selector_shape | underline |
| cta_button_shape | rounded |
| cta_button_shape | square |
| cta_button_shape | underline |
| option_button_shape | rounded |
| option_button_shape | square |
| option_button_shape | underline |
| optional_photos_location | vehicle-details-top |
| optional_photos_location | vehicle-details-bottom |
| assumptions_location | top |
| assumptions_location | bottom |
| price_review_sequencing | high |
| price_review_sequencing | low |
| comparable_vehicles_display | both |
| comparable_vehicles_display | graph |
| comparable_vehicles_display | map |
| comparable_vehicles_display | list |
| comparable_vehicles_summary | both |
| comparable_vehicles_summary | text |
| offer_header | original |
| offer_header | alt-a |
| offer_ready_to_sell | original |
| offer_ready_to_sell | alt-a |
| typeahead_widget_drawer_handle_position | left |
| typeahead_widget_drawer_handle_position | center |
| typeahead_widget_drawer_handle_position | right |
| ddc_cta_type | default |
| ddc_cta_type | primary |
| country | 1 |
| country | 2 |
Search for basic dealership information
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/member/dealer/search/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/dealer/search/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/member/dealer/search/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /member/dealer/search/
Search for basic dealership information
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| search | query | string | false | A search term. |
| limit | query | integer | false | Number of results to return per page. |
| offset | query | integer | false | The initial index from which to return the results. |
Example responses
200 Response
{
"count": 0,
"next": "http://example.com",
"previous": "http://example.com",
"results": [
{
"uuid": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » count | integer | true | none | none |
| » next | string(uri)¦null | false | none | none |
| » previous | string(uri)¦null | false | none | none |
| » results | [DealershipSearch] | true | none | none |
| »» uuid | string | false | none | none |
| »» name | string | true | none | none |
| »» address1 | string¦null | false | none | none |
| »» address2 | string¦null | false | none | none |
| »» city | string¦null | false | none | none |
| »» state | string¦null | false | none | none |
| »» postal_code | string¦null | false | none | none |
Retrieve the current user's content configuration
Code samples
import requests
headers = {
'Accept': 'application/json',
'PerseusDealerUUID': 'string',
'PerseusDealerVDPID': 'string',
'PerseusDealerODID': 'string',
'PerseusDRUUIDConf': 'true',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-content/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'PerseusDealerUUID':'string',
'PerseusDealerVDPID':'string',
'PerseusDealerODID':'string',
'PerseusDRUUIDConf':'true',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-content/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-content/ \
-H 'Accept: application/json' \
-H 'PerseusDealerUUID: string' \
-H 'PerseusDealerVDPID: string' \
-H 'PerseusDealerODID: string' \
-H 'PerseusDRUUIDConf: true' \
-H 'Authorization: Token API_KEY'
GET /member/preferences/current-user-content/
Retrieve the current user's content configuration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| PerseusDealerUUID | header | string | false | Dealership uuid for digital retail implementations |
| PerseusDealerVDPID | header | string | false | Dealership vdpid for digital retail implementations |
| PerseusDealerODID | header | string | false | Dealership odid for digital retail implementations |
| PerseusDRUUIDConf | header | boolean | false | Switch to specify usage of dealership configuration for digital retail implementation |
Example responses
200 Response
{
"en": {},
"fr": {},
"es": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Current user content | ContentConfiguration |
| 403 | Forbidden | Unable to access current user preferences | None |
| 404 | Not Found | Current user has no preferences | None |
Retrieve all the current user's content
Code samples
import requests
headers = {
'Accept': 'application/json',
'PerseusDealerUUID': 'string',
'PerseusDealerVDPID': 'string',
'PerseusDealerODID': 'string',
'PerseusDRUUIDConf': 'true',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-content/all/flat/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'PerseusDealerUUID':'string',
'PerseusDealerVDPID':'string',
'PerseusDealerODID':'string',
'PerseusDRUUIDConf':'true',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-content/all/flat/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-content/all/flat/ \
-H 'Accept: application/json' \
-H 'PerseusDealerUUID: string' \
-H 'PerseusDealerVDPID: string' \
-H 'PerseusDealerODID: string' \
-H 'PerseusDRUUIDConf: true' \
-H 'Authorization: Token API_KEY'
GET /member/preferences/current-user-content/all/flat/
Retrieve all the current user's content in a flat format
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| PerseusDealerUUID | header | string | false | Dealership uuid for digital retail implementations |
| PerseusDealerVDPID | header | string | false | Dealership vdpid for digital retail implementations |
| PerseusDealerODID | header | string | false | Dealership odid for digital retail implementations |
| PerseusDRUUIDConf | header | boolean | false | Switch to specify usage of dealership configuration for digital retail implementation |
Example responses
Current user content
{
"content.key": "content value"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Current user content | None |
| 403 | Forbidden | Unable to access current user preferences | None |
| 404 | Not Found | Current user has no preferences | None |
Response Schema
Retrieve the current user's preferences
Code samples
import requests
headers = {
'Accept': 'application/json',
'PerseusDealerUUID': 'string',
'PerseusDealerVDPID': 'string',
'PerseusDealerODID': 'string',
'PerseusDRUUIDConf': 'true',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-preferences/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'PerseusDealerUUID':'string',
'PerseusDealerVDPID':'string',
'PerseusDealerODID':'string',
'PerseusDRUUIDConf':'true',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-preferences/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-preferences/ \
-H 'Accept: application/json' \
-H 'PerseusDealerUUID: string' \
-H 'PerseusDealerVDPID: string' \
-H 'PerseusDealerODID: string' \
-H 'PerseusDRUUIDConf: true' \
-H 'Authorization: Token API_KEY'
GET /member/preferences/current-user-preferences/
Retrieve the current user's preferences
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| host_domain | query | string | false | Domain to verify against whitelist |
| PerseusDealerUUID | header | string | false | Dealership uuid for digital retail implementations |
| PerseusDealerVDPID | header | string | false | Dealership vdpid for digital retail implementations |
| PerseusDealerODID | header | string | false | Dealership odid for digital retail implementations |
| PerseusDRUUIDConf | header | boolean | false | Switch to specify usage of dealership configuration for digital retail implementation |
Example responses
200 Response
{
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Current user preferences | Preferences |
| 403 | Forbidden | Unable to access current user preferences | None |
| 404 | Not Found | Current user has no preferences | None |
Retrieve the current user's typeahead preferences
Code samples
import requests
headers = {
'Accept': 'application/json',
'PerseusDealerUUID': 'string',
'PerseusDealerVDPID': 'string',
'PerseusDealerODID': 'string',
'PerseusDRUUIDConf': 'true',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-preferences/typeahead/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'PerseusDealerUUID':'string',
'PerseusDealerVDPID':'string',
'PerseusDealerODID':'string',
'PerseusDRUUIDConf':'true',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-preferences/typeahead/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/member/preferences/current-user-preferences/typeahead/ \
-H 'Accept: application/json' \
-H 'PerseusDealerUUID: string' \
-H 'PerseusDealerVDPID: string' \
-H 'PerseusDealerODID: string' \
-H 'PerseusDRUUIDConf: true' \
-H 'Authorization: Token API_KEY'
GET /member/preferences/current-user-preferences/typeahead/
Retrieve the current user's typeahead preferences
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| host_domain | query | string | false | Domain to verify against whitelist |
| PerseusDealerUUID | header | string | false | Dealership uuid for digital retail implementations |
| PerseusDealerVDPID | header | string | false | Dealership vdpid for digital retail implementations |
| PerseusDealerODID | header | string | false | Dealership odid for digital retail implementations |
| PerseusDRUUIDConf | header | boolean | false | Switch to specify usage of dealership configuration for digital retail implementation |
Example responses
200 Response
{
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"ranged_or_gp": "ranged",
"preferred_language": "string",
"country_code": "string",
"widget_google_font_import": "string",
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"widget_enable_host_tracking": true,
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"env_base_url": "string",
"consumer_env_base_url": "string",
"offer_view_base_url": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"typeahead_css_block": "string",
"content_configuration": {}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Current user typeahead preferences | TypeaheadPreferences |
| 403 | Forbidden | Unable to access current user preferences | None |
| 404 | Not Found | Current user has no preferences | None |
misc
Retrieve a list of all exterior colors
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/misc/color/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/misc/color/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/misc/color/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /misc/color/
Retrieve a list of all exterior colors. Default ordering is alphabetically by name.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ordering | query | string | false | Which field to use when ordering the results. |
Example responses
200 Response
[
{
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Color] | false | none | none |
| » id | integer | false | read-only | none |
| » index | integer¦null | false | none | none |
| » name | string | true | none | none |
| » hex_code | string¦null | false | none | HEX code used on front-end display |
| » slug | string(slug) | false | read-only | none |
| » ref_id | integer¦null | false | none | none |
Retrieve a list of all interior colors
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/misc/color/interior/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/misc/color/interior/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/misc/color/interior/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /misc/color/interior/
Retrieve a list of all interior colors. Default ordering is alphabetically by name.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ordering | query | string | false | Which field to use when ordering the results. |
Example responses
200 Response
[
{
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Color] | false | none | none |
| » id | integer | false | read-only | none |
| » index | integer¦null | false | none | none |
| » name | string | true | none | none |
| » hex_code | string¦null | false | none | HEX code used on front-end display |
| » slug | string(slug) | false | read-only | none |
| » ref_id | integer¦null | false | none | none |
offer
Create a new offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/', headers = headers)
print(r.json())
const inputBody = '{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/
Create a new offer
Body parameter
{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Offer | true | none |
Example responses
201 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"dealer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"original_range": "string",
"boosted_offer_range_low": 0,
"boosted_offer_range_high": 0,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
],
"loan_payoff": 0,
"loan_equity": 0,
"has_uploaded_photo_incentive": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Offer created | OfferDetail |
Create and complete an offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/abbreviated/', headers = headers)
print(r.json())
const inputBody = '{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/abbreviated/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/abbreviated/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/abbreviated/
Creates a new offer based on input data and then completes and pushes it.
If push_async is included with a true value then the push step will happen later in the background.
Body parameter
{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferSerializerWithPush | true | none |
Example responses
201 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Offer data | OfferSerializerWithPush |
| 400 | Bad Request | Unable to create offer | None |
View vehicle pricing adjustments
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/adjustments/', params={
'source_id': '0'
}, headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/adjustments/?source_id=0',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/adjustments/?source_id=0 \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/adjustments/
View vehicle pricing adjustments
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source_id | query | integer | true | Vehicle source id |
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| vin | query | string | false | VIN |
| region | query | string | false | Postal code |
Example responses
200 Response
{
"vehicle_odor_adjustment": 0,
"original_owner_adjustment": {
"yes": 0,
"no": 0
},
"carfax_bad_vhr_adjustment": 0,
"frame_damage_adjustment": 0,
"tire_adjustment": {
"excellent": 0,
"good": 0,
"poor": 0
},
"salvage_title_adjustment": 0,
"fire_damage_adjustment": 0,
"flood_damage_adjustment": 0,
"stolen_adjustment": 0,
"mechanical_suspension_adjustment": 0,
"mechanical_sunroof_moonroof_adjustment": 0,
"mechanical_catalytic_converter_adjustment": 0,
"mechanical_engine_adjustment": 0,
"mechanical_brakes_adjustment": 0,
"mechanical_exhaust_adjustment": 0,
"mechanical_transmission_adjustment": 0,
"mechanical_oil_leak_adjustment": 0,
"mechanical_head_gasket_adjustment": 0,
"warning_lights_abs_adjustment": 0,
"warning_lights_brake_adjustment": 0,
"warning_lights_engine_adjustment": 0,
"warning_lights_suspension_fault_adjustment": 0,
"warning_lights_airbag_adjustment": 0,
"warning_lights_battery_adjustment": 0,
"warning_lights_tpms_adjustment": 0,
"warning_lights_traction_control_adjustment": 0,
"modifications_suspension_lowered_adjustment": 0,
"modifications_suspension_raised_adjustment": 0,
"modifications_wheel_adjustment": 0,
"modifications_exhaust_adjustment": 0,
"modifications_aftermarket_tint_adjustment": 0,
"modifications_stereo_adjustment": 0,
"modifications_performance_adjustment": 0,
"modifications_sunroof_moonroof_adjustment": 0,
"modifications_spoiler_adjustment": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Pricing adjustments | PricingAdjustments |
Retrieve a list of offer codes by VIN and CID
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/by-vin-and-cid/{vin}/{cid}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/by-vin-and-cid/{vin}/{cid}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/by-vin-and-cid/{vin}/{cid}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/by-vin-and-cid/{vin}/{cid}/
Retrieve a list of offer codes by VIN and CID
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vin | path | string | true | none |
| cid | path | string | true | none |
Example responses
Offer codes
[
"code"
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer codes | None |
Response Schema
Retrieve an offer by its code
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/byCode/{code}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/byCode/{code}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/byCode/{code}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/byCode/{code}/
Retrieve an offer by its code
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"dealer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"original_range": "string",
"boosted_offer_range_low": 0,
"boosted_offer_range_high": 0,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
],
"loan_payoff": 0,
"loan_equity": 0,
"has_uploaded_photo_incentive": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer information | OfferDetail |
Validate a postal code
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/postal-code-validation/', headers = headers)
print(r.json())
const inputBody = '{
"postal_code": "string",
"make": "string",
"new_vehicle_make": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/postal-code-validation/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/postal-code-validation/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/postal-code-validation/
Validate a postal code
Body parameter
{
"postal_code": "string",
"make": "string",
"new_vehicle_make": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PostalCodeValidation | true | none |
Example responses
Postal code validation
{
"valid": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Postal code validation | None |
| 400 | Bad Request | Unable to validate postal code | None |
Response Schema
Calculate the pricing for offer data
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/pricing/calculate/', headers = headers)
print(r.json())
const inputBody = '{
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"vehicle_color_hex": "strings",
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"vehicle_match": true,
"vehicle_year": 1900,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"pricing_boost_to_market": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"approximate_condition": "excellent",
"carfax_has_bad_vhr": true,
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"vehicle_photos": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/pricing/calculate/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/pricing/calculate/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/pricing/calculate/
Calculate the pricing for offer data. The offer data should include as much information about the offer as possible.
Body parameter
{
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"vehicle_color_hex": "strings",
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"vehicle_match": true,
"vehicle_year": 1900,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"pricing_boost_to_market": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"approximate_condition": "excellent",
"carfax_has_bad_vhr": true,
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"vehicle_photos": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferPricingCalculate | true | none |
Example responses
200 Response
{
"value": "string",
"range": "string",
"pricing_boost_to_market": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Pricing values | OfferPricingResult |
Calculate the pricing trend for offer data
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/pricing/trend/', headers = headers)
print(r.json())
const inputBody = '{
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"vehicle_color_hex": "strings",
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"vehicle_match": true,
"vehicle_year": 1900,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"pricing_boost_to_market": true,
"trend_start_date": "2019-08-24",
"trend_stop_date": "2019-08-24",
"forecasted_dates": [
"2019-08-24"
],
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"approximate_condition": "excellent",
"carfax_has_bad_vhr": true,
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"vehicle_photos": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/pricing/trend/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/pricing/trend/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/pricing/trend/
Calculate the pricing trend for offer data. The offer data should include as much information about the offer as possible.
Body parameter
{
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"vehicle_color_hex": "strings",
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"vehicle_match": true,
"vehicle_year": 1900,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"pricing_boost_to_market": true,
"trend_start_date": "2019-08-24",
"trend_stop_date": "2019-08-24",
"forecasted_dates": [
"2019-08-24"
],
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"approximate_condition": "excellent",
"carfax_has_bad_vhr": true,
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"vehicle_photos": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferPricingTrendCalculate | true | none |
Example responses
200 Response
{
"pricing_trend": [
{
"date": "2019-08-24",
"ico": 0,
"ico_from_offer": true,
"retail": 0
}
],
"pricing": {
"value": "string",
"original_range": "string",
"range": "string",
"completion": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Pricing trend | OfferPricingTrend |
Retrieve a single offer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/
Retrieve a single offer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Offer |
Update an offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.patch('https://perseus-api-production.accu-trade.com/api/offer/{code}/', headers = headers)
print(r.json())
const inputBody = '{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X PATCH https://perseus-api-production.accu-trade.com/api/offer/{code}/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
PATCH /offer/{code}/
Update an offer
Body parameter
{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Offer | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"dealer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"original_range": "string",
"boosted_offer_range_low": 0,
"boosted_offer_range_high": 0,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
],
"loan_payoff": 0,
"loan_equity": 0,
"has_uploaded_photo_incentive": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer updated | OfferDetail |
Complete an offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/complete/', headers = headers)
print(r.json())
const inputBody = '{
"push_async": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/complete/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/complete/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/complete/
Complete an offer entered by a consumer. This finalizes offer pricing and other values.
If push_async is included with a true value then the push step will automatically happen later in the background.
After this step the offer is mostly a read only object.
Body parameter
{
"push_async": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferComplete | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer data | Offer |
| 400 | Bad Request | Unable to complete offer | None |
Push an offer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/complete/push/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/complete/push/',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/complete/push/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/complete/push/
Push a completed offer entered by a consumer. This pushes the offer to the AccuTrade appraiser and other lead configurations specified by the associated dealership(s).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer data | Offer |
| 400 | Bad Request | Unable to push offer | None |
Retrieve the offer consumer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/consumer/
Retrieve the offer consumer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"member_identifier": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"sms_last_sent_at": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ConsumerSimple |
Update the offer consumer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.patch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/', headers = headers)
print(r.json())
const inputBody = '{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"member_identifier": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X PATCH https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
PATCH /offer/{code}/consumer/
Update the offer consumer
Body parameter
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"member_identifier": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ConsumerSimple | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"member_identifier": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"sms_last_sent_at": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ConsumerSimple |
Check the offer consumer verification code
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/check_verification_code/', headers = headers)
print(r.json())
const inputBody = '{
"code": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/check_verification_code/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/check_verification_code/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/consumer/check_verification_code/
Check the offer consumer verification code
Body parameter
{
"code": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VerificationCodeCheck | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"member_identifier": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"sms_last_sent_at": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Valid code | ConsumerSimple |
| 400 | Bad Request | Invalid code | None |
Add masked PII data to the offer consumer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.patch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/masked_data/', headers = headers)
print(r.json())
const inputBody = '[
{
"dealer_id": 0,
"cell_phone": "string",
"email": "user@example.com"
}
]';
const headers = {
'Content-Type':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/masked_data/',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X PATCH https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/masked_data/ \
-H 'Content-Type: application/json' \
-H 'Authorization: Token API_KEY'
PATCH /offer/{code}/consumer/masked_data/
Add masked PII data to the offer consumer
Body parameter
[
{
"dealer_id": 0,
"cell_phone": "string",
"email": "user@example.com"
}
]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferConsumerMaskedData | true | none |
| code | path | string(uuid) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Consumer updated | None |
| 400 | Bad Request | Invalid data | None |
Send the offer consumer verification code
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/send_verification_code/', headers = headers)
print(r.json())
const inputBody = '{
"mode": "sms"
}';
const headers = {
'Content-Type':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/send_verification_code/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/consumer/send_verification_code/ \
-H 'Content-Type: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/consumer/send_verification_code/
Send the offer consumer verification code
Body parameter
{
"mode": "sms"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VerificationCodeSend | true | none |
| code | path | string(uuid) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Code sent | None |
| 400 | Bad Request | Code not sent | None |
Contact dealership selected for offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/contact-dealer/', headers = headers)
print(r.json())
const inputBody = '{
"dealer_id": [
0
],
"message": "string",
"request_appointment": true,
"desire_browse_lot": true,
"desire_test_drive": true,
"desire_consultation": true,
"desire_financing": true,
"desire_sell_only": true
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/contact-dealer/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/contact-dealer/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/contact-dealer/
Contact dealership selected for offer (opts-in if consumer information was suppressed)
Body parameter
{
"dealer_id": [
0
],
"message": "string",
"request_appointment": true,
"desire_browse_lot": true,
"desire_test_drive": true,
"desire_consultation": true,
"desire_financing": true,
"desire_sell_only": true
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferContactDealerMessage | true | none |
| code | path | string(uuid) | true | none |
Example responses
Contact status
{
"dealer_id_1": {
"message": "string"
},
"dealer_id_2": {
"error": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contact status | None |
Response Schema
View local market data related to offer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/local_market/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/local_market/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/local_market/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/local_market/
View local market data related to offer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| radius | query | integer | false | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"count": 0,
"median_price": 0,
"comparable_price": 0,
"median_mileage": 0,
"comparable_mileage": 0,
"comparable_price_adjustment": 0,
"comparable_recondition_adjustment": 0,
"comparable_mileage_adjustment": 0,
"comparable_options_adjustment": 0,
"comparable_depreciation_adjustment": 0,
"comparable_overhead_adjustment": 0,
"comparable_total_adjustment": 0,
"expected_sell_days": 0,
"postal_code_location": [
0,
0
],
"results": [
{
"vin": "string",
"sale_type": "string",
"seller_type": "string",
"stock_number": "string",
"year": 0,
"make": "string",
"model": "string",
"style": "string",
"location": [
0
],
"distance": 0,
"status": "string",
"country": 0,
"mileage": 0,
"price": 0,
"exterior_color": "string",
"thumbnail": "string",
"vdp_link": "string",
"dom": 0,
"last_seen_date": "2019-08-24T14:15:22Z",
"most_comparable": true
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Local market vehicles | OfferLocalMarketResults |
Retrieve offer media
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/media/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/media/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/media/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/media/
Retrieve offer media
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OfferMedia |
Create media content for the offer
Code samples
import requests
headers = {
'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.put('https://perseus-api-production.accu-trade.com/api/offer/{code}/media/create/{category}/', headers = headers)
print(r.json())
const inputBody = '{
"media": "string",
"metadata": [
"string"
]
}';
const headers = {
'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/media/create/{category}/',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X PUT https://perseus-api-production.accu-trade.com/api/offer/{code}/media/create/{category}/ \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
PUT /offer/{code}/media/create/{category}/
Create media content for the offer. Multiple media files can be created at once. The name of each media file can be whatever you choose, eg media1, media2, media3, etc; a, b, c, etc; or another naming convention based on your system requirements or desires.
Body parameter
media: string
metadata:
- string
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| category | path | integer | true | Media category (1 for vehicle, 2 for service records, 3 for modifications, 4 for accidents) |
| body | body | object | true | none |
| » media | body | string(binary) | true | Media file, can have multiple. The parameter name can be anything for example media1, media2, etc. |
| » metadata | body | [string] | false | Media file metadata. Should be an array of objects containing the name of media content being uploaded. Allowed names include: front, front_left_corner, front_right_corner, front_left_tire, front_right_tire, rear, rear_left_corner, rear_right_corner, rear_left_tire, rear_right_tire, left_side, right_side, roof, dashboard, odometer, driver_seat and rear_seat. Metadata should be in the same order as media files. [{"name": "front_left_corner"}, ...] |
| code | path | string(uuid) | true | none |
Example responses
Media created
{
"id": 0,
"urls": {
"original": "string",
"large": "string",
"medium": "string",
"small": "string"
},
"type": "image",
"extension": "string",
"original_file_size": 0,
"original_file_name": "string",
"thumbnails_file_size": null,
"category": 1,
"created_by": {
"id": 0,
"first_name": "string",
"last_name": "string"
},
"modified_by": null,
"index": null,
"created": "datetime",
"modified": "datetime",
"name": "string",
"width": 0,
"height": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Media created | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Media] | false | none | none |
Delete media content for the offer
Code samples
import requests
headers = {
'Authorization': 'Token API_KEY'
}
r = requests.delete('https://perseus-api-production.accu-trade.com/api/offer/{code}/media/destroy/{media_id}/{type}/', headers = headers)
print(r.json())
const headers = {
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/media/destroy/{media_id}/{type}/',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X DELETE https://perseus-api-production.accu-trade.com/api/offer/{code}/media/destroy/{media_id}/{type}/ \
-H 'Authorization: Token API_KEY'
DELETE /offer/{code}/media/destroy/{media_id}/{type}/
Delete media content for the offer. The existing media content will be permanently deleted including all of its metadata and attached files (including thumbnails).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| media_id | path | integer | true | A unique integer value identifying this media |
| type | path | string | true | Media type, either image or document |
| code | path | string(uuid) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Media destroyed | None |
Opt-in to sharing consumer information with suppressed dealership
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/optin-dealer/', headers = headers)
print(r.json())
const inputBody = '{
"dealer_id": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/optin-dealer/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/optin-dealer/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/optin-dealer/
Opt-in to sharing consumer information with suppressed dealership
Body parameter
{
"dealer_id": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferOptInDealer | true | none |
| code | path | string(uuid) | true | none |
Example responses
Opt-in status
{
"dealer_id_1": {
"message": "string"
},
"dealer_id_2": {
"error": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Opt-in status | None |
Response Schema
Retrieve a payoff quote for the offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/payoff_quote/', headers = headers)
print(r.json())
const inputBody = '{
"lender": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/payoff_quote/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/payoff_quote/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/payoff_quote/
Retrieve a payoff quote for the offer
Body parameter
{
"lender": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferPayoff | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"lender_id": "string",
"raw_data": {},
"payoff": 0,
"equity": 0,
"date_pulled": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Payoff information | PayoffData |
| 400 | Bad Request | Unable to retrieve payoff information | None |
Retrieve a refreshed payoff quote for the offer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/payoff_quote/refresh/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/payoff_quote/refresh/',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/payoff_quote/refresh/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/payoff_quote/refresh/
Retrieve a refreshed payoff quote for the offer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"lender_id": "string",
"raw_data": {},
"payoff": 0,
"equity": 0,
"date_pulled": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Payoff information | PayoffData |
| 400 | Bad Request | Unable to refresh payoff information | None |
Add price review information to an offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/price_review/', headers = headers)
print(r.json())
const inputBody = '{
"price_review_vote": true,
"price_review_reason": 1,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/price_review/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/price_review/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/price_review/
Add price review information to an offer
Body parameter
{
"price_review_vote": true,
"price_review_reason": 1,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferPriceReview | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"price_review_vote": true,
"price_review_reason": 1,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Price review information | OfferPriceReview |
| 400 | Bad Request | Unable to update price review information | None |
View all adjustments made on an offer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/pricing/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/pricing/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/pricing/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/pricing/
View all adjustments made on an offer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"total_adjustments": 0,
"vehicle_odor_adjustment": 0,
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"total_vacs_adjustment": 0,
"original_owner_adjustment": 0,
"key_fobs_adjustment": 0,
"insurance_payout_adjustment": 0,
"carfax_bad_vhr_adjustment": 0,
"external_damage_adjustment": 0,
"frame_damage_adjustment": 0,
"tire_adjustment": 0,
"approximate_condition_adjustment": 0,
"extended_warranty_adjustment": 0,
"title_adjustment": 0,
"salvage_title_adjustment": 0,
"fire_damage_adjustment": 0,
"flood_damage_adjustment": 0,
"hail_damage_adjustment": 0,
"stolen_adjustment": 0,
"mechanical_suspension_adjustment": 0,
"mechanical_sunroof_moonroof_adjustment": 0,
"mechanical_catalytic_converter_adjustment": 0,
"mechanical_engine_adjustment": 0,
"mechanical_brakes_adjustment": 0,
"mechanical_exhaust_adjustment": 0,
"mechanical_transmission_adjustment": 0,
"ac_adjustment": 0,
"mechanical_oil_leak_adjustment": 0,
"mechanical_head_gasket_adjustment": 0,
"warning_lights_4x4_adjustment": 0,
"warning_lights_abs_adjustment": 0,
"warning_lights_brake_adjustment": 0,
"warning_lights_engine_adjustment": 0,
"warning_lights_suspension_fault_adjustment": 0,
"warning_lights_airbag_adjustment": 0,
"warning_lights_battery_adjustment": 0,
"warning_lights_tpms_adjustment": 0,
"warning_lights_traction_control_adjustment": 0,
"modifications_suspension_lowered_adjustment": 0,
"modifications_suspension_raised_adjustment": 0,
"modifications_wheel_adjustment": 0,
"modifications_exhaust_adjustment": 0,
"modifications_catalytic_converter_adjustment": 0,
"modifications_aftermarket_tint_adjustment": 0,
"modifications_stereo_adjustment": 0,
"modifications_performance_adjustment": 0,
"modifications_sunroof_moonroof_adjustment": 0,
"modifications_spoiler_adjustment": 0,
"significant_issues_adjustment": 0,
"uploaded_photos_adjustment": 0
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OfferPricing |
Process an offer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/process/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/process/',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/process/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/process/
Process an offer entered by a consumer. Valid offers are sent to Trade desk and AccuTrade. Invalid offers still return a 200 but may trigger other actions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer data | Offer |
| 400 | Bad Request | Unable to process offer | None |
Refresh an offer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/refresh/', headers = headers)
print(r.json())
const inputBody = '{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/refresh/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/refresh/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/refresh/
Creates a new offer based on the existing offer data (with optional updates) and then completes and pushes it.
If push_async is included with a true value then the push step will happen later in the background.
Body parameter
{
"vacs": [
{
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
]
},
"consumer": {
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"profile_picture": {}
},
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"origin_offer_code": "string",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"send_to_marketplace": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"offer_posted_time": "2019-08-24T14:15:22Z",
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"offer_view_url": "string",
"approximate_condition": "excellent",
"single_page_workflow": true,
"carfax_has_bad_vhr": true,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"vehicle_photos": [
0
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferSerializerWithPush | true | none |
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer data | OfferSerializerWithPush |
| 400 | Bad Request | Unable to refresh offer | None |
Retrieve a list of related offers
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/related-offers-by-vin/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/related-offers-by-vin/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/related-offers-by-vin/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/related-offers-by-vin/
Retrieve a list of related offers. Related offers are all offers that are not a draft and have the same VIN number.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
[
{
"id": 0,
"status": "draft",
"type": "consumer",
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"offer_posted_time": "2019-08-24T14:15:22Z",
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"created": "2019-08-24T14:15:22Z",
"trade_desk_view_url": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Related offers | Inline |
Response Schema
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [RelatedOffer] | false | none | none |
| » id | integer | false | read-only | none |
| » status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| » type | string | false | none | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| » supervisor | Staff | true | none | none |
| »» id | integer | false | read-only | none |
| »» archived | string(date-time) | false | read-only | none |
| »» user | User | true | none | none |
| »»» id | integer | false | read-only | none |
| »»» last_login | string(date-time)¦null | false | none | none |
| »»» is_superuser | boolean | false | read-only | Designates that this user has all permissions without explicitly assigning them. |
| »»» username | string | false | read-only | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| »»» first_name | string | false | none | none |
| »»» last_name | string | false | none | none |
| string(email) | false | none | none | |
| »»» is_active | boolean | false | none | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
| »»» date_joined | string(date-time) | false | none | none |
| »» profile_picture | Media | false | none | none |
| »» created | string(date-time) | false | read-only | none |
| »» modified | string(date-time) | false | read-only | none |
| »» address1 | string¦null | false | none | none |
| »» address2 | string¦null | false | none | none |
| »» city | string¦null | false | none | none |
| »» state | string¦null | false | none | none |
| »» postal_code | string¦null | false | none | none |
| »» cell_phone | string¦null | false | none | none |
| »» home_phone | string¦null | false | none | none |
| »» first_name | string¦null | false | none | none |
| »» last_name | string¦null | false | none | none |
| string¦null | false | none | none | |
| »» receives_pending_email | boolean | false | none | none |
| »» hvms_buyer_code | string¦null | false | none | none |
| »» description | string | false | none | none |
| »» show_in_dealer_list | boolean | false | none | none |
| »» role | integer | false | none | Enum Description: 200 - Admin 100 - Manager 1 - Staff 0 - CSR (Read Only) |
| »» is_on_call | boolean | false | none | none |
| »» company | integer | false | read-only | none |
| » offer_posted_time | string(date-time)¦null | false | none | none |
| » source_system | System | true | none | none |
| »» id | integer | false | read-only | none |
| »» created | string(date-time) | false | read-only | none |
| »» modified | string(date-time) | false | read-only | none |
| »» archived | string(date-time)¦null | false | none | none |
| »» name | string | true | none | none |
| »» slug | string(slug) | false | read-only | none |
| »» generates_offer_type | string | false | none | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| »» origin_type_name | string¦null | false | none | none |
| »» generates_multiple_offers | boolean | false | none | none |
| »» does_report_events | boolean | false | none | none |
| »» lead_source_label | string¦null | false | none | Overrides default lead source label |
| »» user | integer | false | none | none |
| »» dealer_group | integer¦null | false | none | none |
| »» company | integer | false | none | none |
| »» partner | integer | false | none | none |
| » created | string(date-time) | false | read-only | none |
| » trade_desk_view_url | string | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| type | consumer |
| type | dealer |
| type | algol |
| role | 200 |
| role | 100 |
| role | 1 |
| role | 0 |
| generates_offer_type | consumer |
| generates_offer_type | dealer |
| generates_offer_type | algol |
Retrieve the offer pricing results
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{code}/results/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/results/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{code}/results/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{code}/results/
Retrieve the offer pricing results. The offer must be posted.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Example responses
200 Response
{
"vehicle_value": 0,
"mileage_value": 0,
"price_per_mile": 0,
"mileage_average": 0,
"mileage_current": 0,
"options_value": 0,
"options": {},
"color_adjustment": 0,
"condition_value": 0,
"condition_adjustments": {
"property1": "string",
"property2": "string"
},
"owed": 0,
"loan_payoff": 0,
"loan_equity": 0,
"trade_credit": 0,
"vehicle_range": [
"string"
],
"original_range": [
"string"
],
"vehicle_offer": 0,
"original_offer": 0,
"boosted_offer": true,
"boosted_value": 0,
"offer_ceiling": 0,
"barcode_value": "string",
"untaxed_amount": 0,
"state_tax": 0,
"dealer_sale_time": "string",
"dealer_tax_savings": 0,
"dealer_expected_depreciation": 0,
"private_expected_depreciation": 0,
"private_sale_time": "string",
"private_tax_savings": 0,
"selected_dealerships": [
"string"
],
"expired": true,
"expired_date": "2019-08-24T14:15:22Z",
"oem_gtp": {
"oem_name": "string",
"gtp_price": 0,
"max_miles": 0,
"expiration": "2019-08-24",
"errors": [
"string"
],
"show_gtp": true
},
"accident_adjustment": 0,
"market_average": 0,
"market_low": 0,
"market_high": 0,
"needs_dealer_review": true,
"outside_service_area": true,
"show_uploaded_photo_incentive": true,
"has_uploaded_photo_incentive": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Offer pricing results | OfferPricingResults |
| 400 | Bad Request | Unable to view offer pricing results | None |
Send an existing offer to another dealer
Code samples
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/send_to_dealer/', headers = headers)
print(r.json())
const inputBody = '{
"id": "string",
"selection_type": "string",
"reason": "string",
"display_position": "string",
"scores": {},
"makes": "string",
"profile_url": "string"
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/send_to_dealer/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/send_to_dealer/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/send_to_dealer/
Send an existing offer to another dealer
Body parameter
{
"id": "string",
"selection_type": "string",
"reason": "string",
"display_position": "string",
"scores": {},
"makes": "string",
"profile_url": "string"
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | OfferSendToDealer | true | none |
| code | path | string(uuid) | true | none |
Example responses
201 Response
{
"id": "string",
"selection_type": "string",
"reason": "string",
"display_position": "string",
"scores": {},
"makes": "string",
"profile_url": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | OfferSendToDealer |
Send SMS requesting photos from consumer
Code samples
import requests
headers = {
'Authorization': 'Token API_KEY'
}
r = requests.post('https://perseus-api-production.accu-trade.com/api/offer/{code}/sms-picture-request/', headers = headers)
print(r.json())
const headers = {
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{code}/sms-picture-request/',
{
method: 'POST',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X POST https://perseus-api-production.accu-trade.com/api/offer/{code}/sms-picture-request/ \
-H 'Authorization: Token API_KEY'
POST /offer/{code}/sms-picture-request/
Send SMS requesting photos from consumer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| code | path | string(uuid) | true | none |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | SMS sent | None |
Check for existing offers by VIN
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{vin}/check-active-offer-exists/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{vin}/check-active-offer-exists/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{vin}/check-active-offer-exists/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{vin}/check-active-offer-exists/
Check for existing offers by VIN. Returns exists as True if there is an existing offer within the past
ten days that is not a draft. Otherwise returns exists as False.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vin | path | string | true | none |
Example responses
Has open offers
{
"exists": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Has open offers | None |
Response Schema
Check for existing offers by VIN and VDP
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{vin}/check-active-offer-exists/{vdpid}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{vin}/check-active-offer-exists/{vdpid}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{vin}/check-active-offer-exists/{vdpid}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{vin}/check-active-offer-exists/{vdpid}/
Check for existing offers by VIN and VDP. Returns exists as True if there is an existing offer this is
not a draft. Otherwise returns exists as False.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vin | path | string | true | none |
| vdpid | path | string | true | none |
Example responses
Has open offers
{
"exists": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Has open offers | None |
Response Schema
Retrieve an existing/active offer by VIN and dealer
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/offer/{vin}/get-active-offer/{dealer_uuid}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/offer/{vin}/get-active-offer/{dealer_uuid}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/offer/{vin}/get-active-offer/{dealer_uuid}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /offer/{vin}/get-active-offer/{dealer_uuid}/
Retrieve an existing/active offer by VIN and dealer. PII is not included in the response.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vin | path | string | true | none |
| dealer_uuid | path | string | true | none |
Example responses
200 Response
{
"id": 0,
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"type": "consumer",
"plate_state": "st",
"plate_number": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_specialized": true,
"vehicle_mismatch": true,
"vehicle_image": "string",
"vehicle_includes": "string",
"vehicle_engine_type": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"color_adjustment": -2147483648,
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"vehicle_mileage": -2147483648,
"vehicle_base_miles": -2147483648,
"mileage_adjustment": -2147483648,
"postal_code_adjustment": -2147483648,
"is_over_mileage": "string",
"approximate_condition": "excellent",
"is_original_owner": true,
"is_liened": true,
"liened_type": "loan",
"owed_amount": -2147483648,
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"is_interested_new_vehicle": true,
"new_vehicle_type": "new",
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source": 1,
"new_vehicle_source_id": "string",
"has_accident": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": -2147483648,
"has_frame_damage": true,
"frame_damage_adjustment": -2147483648,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": -2147483648,
"has_external_damage": true,
"external_damage_amount": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"has_mechanical_issues": true,
"has_mechanical_ac": true,
"has_mechanical_brakes": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_head_gasket": true,
"has_mechanical_oil_leak": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_transmission": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_warning_lights": true,
"has_warning_lights_abs": true,
"has_warning_lights_srs": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_tpms": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_suspension_lifted": true,
"has_modifications_suspension_lowered": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_odor": true,
"vehicle_odor_adjustment": -2147483648,
"has_other_issues": true,
"is_salvage_title": true,
"is_rebuilt_title": true,
"salvage_title_adjustment": -2147483648,
"has_fire_damage": true,
"has_flood_damage": true,
"was_stolen": true,
"other_issues_repair_cost": 0,
"consumer": 0,
"expect_transact_months": 0,
"status": "draft",
"needs_dealer_review": "string",
"offer_posted_time": "2019-08-24T14:15:22Z",
"pricing_type": "ranged",
"pricing_country": 1,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price": "string",
"range_low": -2147483648,
"range_high": -2147483648,
"guaranteed_price": -2147483648,
"vehicle_offer_price": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"expired": "string",
"is_dsa_offer": true,
"assigned_dealerships": [
0
],
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"company": 0,
"partner": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"source_system": {
"id": 0,
"name": "string",
"slug": "string",
"company": 0,
"partner": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"partner": "string",
"offer_return_link": "string",
"is_testing": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Active offer | OfferSimple |
| 404 | Not Found | No active offer found | None |
vehicle
Get vehicle information by GID (DEPRECATED)
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/by-guid/{gid}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/by-guid/{gid}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/by-guid/{gid}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/by-guid/{gid}/
Get vehicle information by GID. Returns detailed information for the matching vehicle. (DEPRECATED)
Please use /api/vehicle/data/v2/:gid/ instead.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| region | query | string | false | Postal code |
| gid | path | string | true | none |
Example responses
Vehicle information
{
"source": 1,
"gid": 123456,
"year": 2000,
"make": "string",
"model": "string",
"style": "string",
"includes": "string",
"vacs": [
{
"id": 0,
"addded": "A",
"ro": false,
"exc": [],
"desc": "string",
"amt": 300,
"inc": false,
"mutex": [],
"disabled": false
}
],
"specialized": false
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Vehicle information | None |
Response Schema
Get vehicle information by GID and VIN (DEPRECATED)
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/by-guid/{gid}/{vin}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/by-guid/{gid}/{vin}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/by-guid/{gid}/{vin}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/by-guid/{gid}/{vin}/
Get vehicle information by GID and VIN. Returns detailed information for the matching vehicle. (DEPRECATED)
Please use /api/vehicle/data/v2/:gid/:vin/ instead.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| region | query | string | false | Postal code |
| gid | path | string | true | none |
| vin | path | string | true | none |
Example responses
Vehicle information
{
"source": 1,
"specialized": false,
"year": 2000,
"make": "string",
"model": "string",
"style": "string",
"gid": 123456,
"vacs": []
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Vehicle information | None |
Response Schema
Get vehicles by VIN
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/by-vin/{vin}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/by-vin/{vin}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/by-vin/{vin}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/by-vin/{vin}/
Get vehicles by VIN. Returns a list of matching vehicles.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| vin | path | string | true | none |
Example responses
Matching vehicles
[
{
"gid": "string",
"year": 2000,
"make": "string",
"model": "string",
"style": "string",
"source": 1,
"specialized": false
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Matching vehicles | None |
Response Schema
Get vehicle data by GID
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/data/v2/{gid}/', params={
'gid': 'string'
}, headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/data/v2/{gid}/?gid=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/data/v2/{gid}/?gid=string \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/data/v2/{gid}/
Get vehicle data by GID. Returns detailed information for the matching vehicle.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves) |
| region | query | string | false | Postal code |
| gid | query | string | true | Galves Vehicle ID |
| gid | path | string | true | none |
Example responses
200 Response
{
"source": 0,
"gid": "string",
"book": "string",
"year": 0,
"make": "string",
"model": "string",
"trim": "string",
"style": "string",
"body": "string",
"engine": "string",
"vehicle_class": "string",
"base_mileage": 0,
"standard_equipment": "string",
"options": [
{
"ref_id": 0,
"description": "string",
"addded": "string",
"selected": true,
"mutex": [
0
],
"disabled": true
}
],
"specialized": true,
"vin_gid_mismatch": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Vehicle data | VehicleDataSerializerV2 |
Get vehicle data by GID and VIN
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/data/v2/{gid}/{vin}/', params={
'gid': 'string'
}, headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/data/v2/{gid}/{vin}/?gid=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/data/v2/{gid}/{vin}/?gid=string \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/data/v2/{gid}/{vin}/
Get vehicle data by GID and VIN. Returns detailed information for the matching vehicle.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves) |
| region | query | string | false | Postal code |
| gid | query | string | true | Galves Vehicle ID |
| gid | path | string | true | none |
| vin | path | string | true | none |
Example responses
200 Response
{
"source": 0,
"gid": "string",
"book": "string",
"year": 0,
"make": "string",
"model": "string",
"trim": "string",
"style": "string",
"body": "string",
"engine": "string",
"vehicle_class": "string",
"base_mileage": 0,
"standard_equipment": "string",
"options": [
{
"ref_id": 0,
"description": "string",
"addded": "string",
"selected": true,
"mutex": [
0
],
"disabled": true
}
],
"specialized": true,
"vin_gid_mismatch": true
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Vehicle data | VehicleDataSerializerV2 |
Retrieve available vehicle makes
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/makes/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/makes/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/makes/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/makes/
Retrieve available vehicle makes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| replacement | query | string | false | When "true", old makes will be hidden |
Example responses
Available makes
[
{
"make": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available makes | None |
Response Schema
Retrieve available new vehicle makes
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/makes/new/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/makes/new/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/makes/new/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/makes/new/
Retrieve available new vehicle makes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| configured_makes | query | boolean | false | Filter result makes to only include makes desired by user configuration |
Example responses
Available makes
[
{
"make": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available makes | None |
Response Schema
Retrieve available vehicle makes by year
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/makes/{year}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/makes/{year}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/makes/{year}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/makes/{year}/
Retrieve available vehicle makes by year
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| configured_makes | query | boolean | false | Filter result makes to only include makes desired by user configuration |
| year | path | string | true | none |
Example responses
Available makes
[
{
"make": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available makes | None |
Response Schema
Retrieve available new vehicle models by make
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/models/new/{make}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/models/new/{make}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/models/new/{make}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/models/new/{make}/
Retrieve available new vehicle models by make
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| make | path | string | true | none |
Example responses
Available models
[
{
"model": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available models | None |
Response Schema
Retrieve available vehicle models by year and make
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/models/{year}/{make}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/models/{year}/{make}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/models/{year}/{make}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/models/{year}/{make}/
Retrieve available vehicle models by year and make
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| year | path | string | true | none |
| make | path | string | true | none |
Example responses
Available models
[
{
"model": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available models | None |
Response Schema
Get vehicle picture by GID
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-guid/{gid}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-guid/{gid}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-guid/{gid}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/picture/by-guid/{gid}/
Get vehicle picture by GID. Returns URL to the vehicle image if found. Otherwise returns empty response.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| chrome_style_id | query | integer | false | Chrome style ID |
| exterior_color_hex | query | string | false | Vehicle color HEX code |
| gid | path | string | true | none |
Example responses
URL to image
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | URL to image | None |
Response Schema
Get vehicle picture by GID and VIN
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-guid/{gid}/{vin}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-guid/{gid}/{vin}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-guid/{gid}/{vin}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/picture/by-guid/{gid}/{vin}/
Get vehicle picture by GID and VIN. Returns URL to the vehicle image if found. Otherwise returns empty response.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| chrome_style_id | query | integer | false | Chrome style ID |
| exterior_color_hex | query | string | false | Vehicle color HEX code |
| gid | path | string | true | none |
| vin | path | string | true | none |
Example responses
URL to image
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | URL to image | None |
Response Schema
Get vehicle picture by VIN
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-vin/{vin}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-vin/{vin}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/picture/by-vin/{vin}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/picture/by-vin/{vin}/
Get vehicle picture by VIN. Returns URL to the vehicle image if found. Otherwise returns empty response.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| chrome_style_id | query | integer | false | Chrome style ID |
| exterior_color_hex | query | string | false | Vehicle color HEX code |
| vin | path | string | true | none |
Example responses
URL to image
"string"
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | URL to image | None |
Response Schema
Search for AccuTrade vehicle
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/search/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/search/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/search/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/search/
Search for AccuTrade vehicle using the supplied parameters. The best matching AccuTrade vehicle will be returned. The returned vehicle is not guaranteed to be the correct match. The more parameters supplied the more accurate the result.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| gid | query | string | false | none |
| guid | query | string | false | Deprecated, use gid |
| vin | query | string | false | none |
| vin_root | query | string | false | none |
| license_plate_number | query | string | false | none |
| license_plate_state | query | string | false | none |
| chrome_id | query | string | false | Deprecated, use chrome_style_id |
| chrome_style_id | query | string | false | none |
| year | query | integer | false | none |
| make | query | string | false | none |
| model | query | string | false | none |
| style | query | string | false | none |
Example responses
Best matching vehicle
{
"gid": "123456",
"year": 2000,
"make": "string",
"model": "string",
"style": "string",
"available_styles": [
{
"gid": "123456",
"style": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Best matching vehicle | None |
| 400 | Bad Request | Invalid request data | None |
| 404 | Not Found | No vehicle found | None |
Response Schema
Retrieve available new vehicle styles by make and model
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/styles/new/{make}/{model}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/styles/new/{make}/{model}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/styles/new/{make}/{model}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/styles/new/{make}/{model}/
Retrieve available new vehicle styles by make and model
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| make | path | string | true | none |
| model | path | string | true | none |
Example responses
Available styles
[
{
"style": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available styles | None |
Response Schema
Retrieve available vehicle styles by year, make, and model
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/styles/{year}/{make}/{model}/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/styles/{year}/{make}/{model}/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/styles/{year}/{make}/{model}/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/styles/{year}/{make}/{model}/
Retrieve available vehicle styles by year, make, and model
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| source | query | integer | false | Vehicle source (1 for Galves, 2 for Chrome) |
| year | path | string | true | none |
| make | path | string | true | none |
| model | path | string | true | none |
Example responses
Available styles
[
{
"style": "string",
"gid": 0,
"source": 1,
"year": "2000",
"make": "string",
"model": "string",
"specialized": false
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available styles | None |
Response Schema
Retrieve vehicle suggestions based on search term
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/typeahead_search/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/typeahead_search/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/typeahead_search/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/typeahead_search/
Retrieve vehicle suggestions based on search term
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| qry | query | string | false | legacy field |
| search | query | string | false | same as qry just named better |
| count | query | integer | false | none |
| include_score | query | boolean | false | none |
| replacement | query | boolean | false | none |
Example responses
Search results
[
{
"gid": "123456",
"vin": "string",
"year": 2000,
"make": "string",
"model": "string",
"trim": "string",
"style": "string"
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Search results | None |
| 400 | Bad Request | Invalid request data | None |
Response Schema
Retrieve available vehicle years
Code samples
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'Token API_KEY'
}
r = requests.get('https://perseus-api-production.accu-trade.com/api/vehicle/years/', headers = headers)
print(r.json())
const headers = {
'Accept':'application/json',
'Authorization':'Token API_KEY'
};
fetch('https://perseus-api-production.accu-trade.com/api/vehicle/years/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X GET https://perseus-api-production.accu-trade.com/api/vehicle/years/ \
-H 'Accept: application/json' \
-H 'Authorization: Token API_KEY'
GET /vehicle/years/
Retrieve available vehicle years
Example responses
Available years
[
{
"year": 2000
}
]
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Available years | None |
Response Schema
Schemas
ALGolLeaseOption
{
"name": "string",
"selected": false
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| selected | boolean | false | none | none |
OfferVac
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| description | string | true | none | Vehicle option description. Comes from vehicle_data.options.description |
| addded | string | true | none | Vehicle option ADD or DEDUCT. Comes from vehicle_data.options.addded |
| ref_id | integer | true | none | Vehicle option reference ID. Comes from vehicle_data.options.ref_id |
| amount | integer | false | none | Read-only vehicle option valuation. |
| selected | boolean | true | none | Toggle indicating if vehicle option is selected for the current vehicle. Must be TRUE if vehicle_data.options.selected is TRUE |
| offer | integer | false | read-only | none |
DictionaryMedia
{}
Properties
None
Media
{}
Properties
None
OfferMedia
{
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| vehicle | DictionaryMedia | true | none | none |
| service_records | [Media] | true | none | none |
| modifications | [Media] | true | none | none |
| accident | [Media] | true | none | none |
| stock_image | object¦null | false | read-only | none |
| » additionalProperties | string¦null | false | none | none |
OfferDetailConsumer
{
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| first_name | string¦null | false | none | none |
| last_name | string¦null | false | none | none |
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
| cell_phone | string¦null | false | none | none |
| home_phone | string¦null | false | none | none |
| string¦null | false | none | none | |
| best_time_to_contact | string¦null | false | none | Enum Description: 0 - Unknown 1 - Morning 2 - Afternoon 3 - Evening |
| preferred_contact_method | string¦null | false | none | Enum Description: phone - Phone email - Email |
| phone_verified | boolean¦null | false | none | none |
| bypass_validation | boolean | false | none | none |
| member_identifier | string¦null | false | none | none |
| sms_last_sent_at | string(date-time)¦null | false | read-only | none |
| profile_picture | Media | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| best_time_to_contact | 0 |
| best_time_to_contact | 1 |
| best_time_to_contact | 2 |
| best_time_to_contact | 3 |
| preferred_contact_method | phone |
| preferred_contact_method |
Color
{
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| index | integer¦null | false | none | none |
| name | string | true | none | none |
| hex_code | string¦null | false | none | HEX code used on front-end display |
| slug | string(slug) | false | read-only | none |
| ref_id | integer¦null | false | none | none |
CRMLead
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | none | none |
| type | string | false | none | none |
| format | string | true | none | none |
| target | string | true | none | none |
| lead_source | string¦null | false | none | none |
| lead_source_types | [string]¦null | false | none | none |
| string(email) | false | none | none | |
| phone | string | false | none | none |
| api_url | string(uri)¦null | false | none | none |
| api_data | object | false | none | none |
| name | string | false | none | none |
| lead_source_type | string¦null | false | none | Enum Description: dsa - DSA - 3rd Party Website dr3 - Digital Retail - 3rd Party Website dr1 - Digital Retail - Dealers Website dww - Widget - Dealers Website driveway - Widget - Dealers Website - Driveway Appraisal campaign - Widget - Dealers Website - Campaign |
| lead_identifier | string¦null | false | none | none |
| descriptor | string | false | none | none |
| provider | string¦null | false | none | Overrides ADF provider name tag |
| provider_service | string¦null | false | none | Overrides ADF provider service tag |
Enumerated Values
| Property | Value |
|---|---|
| lead_source_type | dsa |
| lead_source_type | dr3 |
| lead_source_type | dr1 |
| lead_source_type | dww |
| lead_source_type | driveway |
| lead_source_type | campaign |
FacilitationLocation
{
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| name | string | true | none | none |
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
| contact | string | false | none | none |
| instructions | string | false | none | none |
Preferences
{
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| partner_identifier | string | false | none | none |
| branding_identifier | string | false | read-only | none |
| pricing_country | string | false | none | Enum Description: usa - United States canada - Canada |
| single_page_workflow | boolean | false | none | Deprecated, use digital_retail_experience and ranged_or_gp instead |
| combined_details_conditions_page | boolean | false | none | none |
| digital_retail_experience | boolean | false | none | none |
| digital_retail_uuid_configs | boolean | false | none | If dealer uuid/vdpid/odid specified when loading preferences then prefer dealer preferences over system |
| show_pii_for_digital_retail | boolean | false | none | none |
| hide_digital_retail_offer_page | boolean | false | none | none |
| root_branding_enabled | boolean | false | none | none |
| accu_trade_appraiser | boolean¦null | false | none | Deprecated, should be True |
| ranged_or_gp | string¦null | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price disabled - Disabled ranged_and_gp - Ranged and Guaranteed Price ymmt_gp - YMMT Guaranteed Price single_page_ranged - Single Page Ranged |
| vin_to_value_enabled | boolean | false | none | none |
| autocheck_vhr_disabled | boolean | false | none | none |
| autocheck_hide_questions | boolean | false | none | Hides consumer flow questions if autocheck data answers them |
| pricing_boost_to_market | boolean | false | none | none |
| voi_required | boolean | false | none | none |
| show_oem_gtp | integer¦null | false | none | Enum Description: 1 - Higher 2 - Always |
| bypass_no_value_check | boolean | false | none | none |
| low_value_dealer_review | boolean | false | none | none |
| combined_dcp_enabled | boolean | false | none | Combined details/conditions/prospect pages, aka hybrid vin-to-value |
| combined_dcp_simplified_header | boolean | false | none | none |
| enable_condensed_conditions | boolean | false | none | none |
| show_dealer_group_dropdown | boolean¦null | false | none | none |
| dsa_lookup_type | string | false | none | Enum Description: voi - VOI |
| preferred_language | string | false | read-only | none |
| supported_languages | [string] | false | read-only | none |
| show_language_switch | boolean | false | none | Deprecated, use language_switch |
| language_switch | string¦null | false | none | Enum Description: menu - Menu inline - Inline |
| content_pieces | string | false | read-only | none |
| tax_discount | number(decimal) | false | none | none |
| google_tracker | string | false | none | none |
| google_conversion | string | false | none | none |
| google_conversion_id | string | false | none | none |
| google_conversion_label | string | false | none | none |
| google_conversion_id_consumer_engagement | string | false | none | none |
| google_conversion_label_consumer_engagement | string | false | none | none |
| google_tag_manager_id | string¦null | false | none | none |
| has_ga4_measurement_config | string | false | read-only | none |
| ga4_measurement_ids | object | false | none | none |
| enable_send_to | boolean | false | none | none |
| offer_view_base_url | string¦null | false | none | none |
| appointment_email | string(email) | false | none | none |
| appointment_contact | string | false | none | none |
| advanced_offer_lead_selection | boolean | false | none | Deprecated, always on for DSA systems |
| dsa_enabled | string | false | read-only | none |
| is_utf7 | boolean¦null | false | none | none |
| crm_leads | [CRMLead] | true | none | none |
| facilitation_location | FacilitationLocation | true | none | none |
| replacement_vehicle | boolean¦null | false | none | none |
| show_new | boolean¦null | false | none | none |
| show_used | boolean¦null | false | none | none |
| show_cpo | boolean¦null | false | none | none |
| replacement_vehicle_makes | string | false | read-only | none |
| voi_trim_required | string | false | read-only | none |
| consumer_offer_expiration_period | integer | false | none | none |
| dealer_offer_expiration_period | integer | false | none | none |
| banner_url | string¦null | false | none | none |
| mobile_banner_url | string¦null | false | none | none |
| logo_url | string¦null | false | none | none |
| logo_url_driveway | string¦null | false | none | none |
| vehicle_entry_default | string | false | none | Enum Description: licensePlate - Plate vin - VIN ymmt - YMMT |
| deemphasize_vehicle_entry_ymmt | boolean | false | none | none |
| vehicle_entry_selector_shape | string | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| color_selector_shape | string¦null | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| cta_button_shape | string | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| option_button_shape | string¦null | false | none | Enum Description: rounded - Rounded square - Square underline - Underline |
| hide_original_owner | boolean | false | none | none |
| hide_zip_code_field | boolean | false | none | none |
| hide_zip_code_field_on_pii | boolean | false | none | none |
| enable_geolocation | boolean | false | none | none |
| enable_advanced_color_selector | boolean | false | none | none |
| hide_vehicle_color_selector | boolean | false | none | none |
| hide_interior_color_selector | boolean | false | none | none |
| hide_vin_field | boolean | false | none | none |
| show_tax_savings_on_pii_page | boolean | false | none | none |
| suppress_address | boolean | false | none | none |
| expand_offer_condition_details | boolean | false | none | none |
| hide_offer_tax_savings | boolean | false | none | none |
| incorporate_tax_savings | boolean | false | none | none |
| hide_offer_breakdown | boolean | false | none | none |
| hide_offer_next_steps | boolean | false | none | none |
| hide_offer_dealer_contact_section | boolean | false | none | none |
| hide_vehicle_estimate_header | boolean | false | none | none |
| vehicle_estimate_header_text_color | string¦null | false | none | none |
| hide_footer | boolean | false | none | none |
| hide_how_it_works | boolean | false | none | none |
| hide_home_header | boolean | false | none | none |
| hide_header_price_during_survey | boolean | false | none | none |
| show_header_video | boolean | false | none | none |
| show_system_alert | boolean | false | none | none |
| show_estimate_condition | boolean | false | none | none |
| show_estimate_cell_phone | boolean | false | none | none |
| hide_estimate_original_owner | boolean | false | none | none |
| estimate_replacement_vehicle | boolean | false | none | none |
| hide_plate_to_vin | boolean | false | none | none |
| plate_to_vin_state_geolocation | boolean | false | none | none |
| show_keys_question | boolean | false | none | none |
| show_estimate_is_liened | boolean | false | none | none |
| show_gp_is_liened | boolean | false | none | none |
| show_gp_cell_phone | boolean | false | none | none |
| hide_gp_ymmt_fields | boolean | false | none | none |
| hide_pii_step | boolean | false | none | none |
| hide_last_name_field | boolean | false | none | none |
| hide_email_field | boolean | false | none | none |
| show_member_identifier | boolean | false | none | none |
| show_expected_transaction | boolean | false | none | none |
| show_best_time_to_contact | boolean | false | none | none |
| show_notes_entry | boolean | false | none | none |
| show_phone_verification | boolean | false | none | none |
| show_photo_upload_on_offer | boolean | false | none | none |
| show_estimate_photo_upload_on_offer | boolean | false | none | none |
| expand_photo_upload_on_offer | boolean | false | none | none |
| enable_photo_guidance | boolean | false | none | none |
| show_optional_photos | boolean | false | none | none |
| optional_photos_required | boolean | false | none | none |
| optional_photos_location | string | false | none | Enum Description: vehicle-details-top - Vehicle details top vehicle-details-bottom - Vehicle details bottom |
| assumptions_location | string | false | none | Enum Description: top - Top bottom - Bottom |
| enable_editable_assumptions | boolean | false | none | none |
| show_price_review | boolean | false | none | none |
| price_review_sequencing | string | false | none | Enum Description: high - High low - Low |
| show_comparable_vehicles | boolean | false | none | none |
| hide_comparable_vehicles_spread_table | boolean | false | none | none |
| comparable_vehicles_display | string | false | none | Enum Description: both - Both graph - Graph map - Map list - List |
| comparable_vehicles_displays | [string] | true | none | none |
| comparable_vehicles_summary | string | false | none | Enum Description: both - Both text - Text |
| show_equity_payout_on_offer | boolean | false | none | none |
| show_equity_payout_on_detail | boolean | false | none | none |
| show_single_value_offer_estimate | boolean | false | none | none |
| offer_header | string | false | none | Enum Description: original - Original alt-a - Alternative A |
| offer_ready_to_sell | string | false | none | Enum Description: original - Original alt-a - Alternative A |
| offer_ready_alt_background_color | string¦null | false | none | none |
| offer_ready_alt_text_color | string¦null | false | none | none |
| offer_ready_alt_primary_button_color | string¦null | false | none | none |
| offer_ready_alt_primary_button_text_color | string¦null | false | none | none |
| offer_ready_alt_secondary_button_color | string¦null | false | none | none |
| offer_ready_alt_secondary_button_text_color | string¦null | false | none | none |
| offer_ready_alt_secondary_button_border_color | string¦null | false | none | none |
| use_submitted_vehicle_image | boolean | false | none | none |
| should_send_to_showroom_leads | boolean | false | none | none |
| cell_phone_optional | boolean | false | none | none |
| show_branded_banner | boolean | false | none | none |
| show_confirmation_hero | boolean | false | none | none |
| hide_contact_cta_on_offer | boolean | false | none | none |
| show_offer_html_block | boolean | false | none | none |
| hide_vin_field_on_registration | boolean | false | none | none |
| enable_context_price_display | boolean | false | none | none |
| disable_focus_outline | boolean | false | none | none |
| focus_outline_color | string¦null | false | none | none |
| disable_page_change_scroll | boolean | false | none | none |
| page_change_scroll_offset_desktop | integer¦null | false | none | none |
| page_change_scroll_offset_mobile | integer¦null | false | none | none |
| disable_history_state | boolean¦null | false | none | none |
| widget_enable_host_tracking | boolean | false | none | none |
| banner_color | string¦null | false | none | none |
| cert_banner_color | string¦null | false | none | none |
| cert_compare_background_color | string¦null | false | none | none |
| cert_summary_background_color | string¦null | false | none | none |
| cert_summary_text_color | string¦null | false | none | none |
| cert_summary_separator_color | string¦null | false | none | none |
| default_text_color | string¦null | false | none | none |
| deemphasized_text_color | string¦null | false | none | none |
| heading_text_color | string¦null | false | none | none |
| footer_background_color | string¦null | false | none | none |
| footer_text_color | string¦null | false | none | none |
| footer_link_color | string¦null | false | none | none |
| link_color | string¦null | false | none | none |
| vehicle_entry_selector_border_color | string¦null | false | none | none |
| vehicle_entry_selector_button_fill_color | string¦null | false | none | none |
| vehicle_entry_selector_text_color | string¦null | false | none | none |
| vehicle_entry_selector_selected_text_color | string¦null | false | none | none |
| enable_ymmt_column_layout | boolean | false | none | none |
| enable_alt_trim_selection | boolean | false | none | none |
| option_selection_color | string¦null | false | none | none |
| option_button_text_color | string¦null | false | none | none |
| option_button_selected_text_color | string¦null | false | none | none |
| option_button_unselected_border_color | string¦null | false | none | none |
| primary_button_background_color | string¦null | false | none | none |
| primary_button_text_color | string¦null | false | none | none |
| secondary_button_background_color | string¦null | false | none | none |
| secondary_button_text_color | string¦null | false | none | none |
| secondary_button_border_color | string¦null | false | none | none |
| separator_color | string¦null | false | none | none |
| primary_header_text_color | string¦null | false | none | none |
| step_info_header_background_color | string¦null | false | none | none |
| step_info_header_text_color | string¦null | false | none | none |
| section_background_color | string¦null | false | none | none |
| autocheck_message_text_color | string¦null | false | none | none |
| autocheck_message_background_color | string¦null | false | none | none |
| autocheck_message_border_color | string¦null | false | none | none |
| autocheck_warn_background_color | string¦null | false | none | none |
| autocheck_warn_icon_color | string¦null | false | none | none |
| tab_color | string¦null | false | none | none |
| tab_separator_color | string¦null | false | none | none |
| details_conditions_separator_color | string¦null | false | none | none |
| form_field_placeholder_color | string¦null | false | none | none |
| form_field_title_color | string¦null | false | none | none |
| form_field_text_color | string¦null | false | none | none |
| form_field_border_color | string¦null | false | none | none |
| negative_value_color | string¦null | false | none | none |
| positive_value_color | string¦null | false | none | none |
| form_checkbox_color | string¦null | false | none | none |
| form_checkbox_unselected_color | string¦null | false | none | none |
| offer_condition_label_color | string¦null | false | none | none |
| offer_condition_value_color | string¦null | false | none | none |
| widget_google_font_import | string | false | none | none |
| font_family | string¦null | false | none | none |
| widget_banner_hide_logo | boolean | false | none | none |
| widget_drawer_hide_logo | boolean | false | none | none |
| typeahead_widget_banner_color | string¦null | false | none | none |
| typeahead_widget_banner_font_color | string¦null | false | none | none |
| typeahead_widget_banner_font_family | string¦null | false | none | none |
| typeahead_widget_banner_font_size | string¦null | false | none | none |
| typeahead_widget_banner_height | integer¦null | false | none | none |
| typeahead_widget_banner_mobile_height | integer¦null | false | none | none |
| typeahead_widget_banner_background | string | false | none | none |
| typeahead_widget_banner_mobile_background | string | false | none | none |
| typeahead_drawer_color | string¦null | false | none | none |
| typeahead_drawer_font_color | string¦null | false | none | none |
| typeahead_drawer_font_family | string¦null | false | none | none |
| typeahead_drawer_font_size | string¦null | false | none | none |
| typeahead_drawer_handle_color | string¦null | false | none | none |
| typeahead_drawer_handle_text_color | string¦null | false | none | none |
| typeahead_widget_drawer_handle_height | integer¦null | false | none | none |
| typeahead_widget_drawer_handle_position | string¦null | false | none | Enum Description: left - Left center - Center right - Right |
| typeahead_drawer_force_ontop | boolean | false | none | none |
| typeahead_hero_color | string¦null | false | none | none |
| typeahead_hero_font_color | string¦null | false | none | none |
| typeahead_hero_font_family | string¦null | false | none | none |
| typeahead_hero_font_size | string¦null | false | none | none |
| typeahead_widget_hero_banner_color | string¦null | false | none | none |
| typeahead_widget_hero_banner_text_color | string¦null | false | none | none |
| show_uploaded_photo_incentive | boolean | false | none | none |
| photo_incentive_value | integer¦null | false | none | none |
| css_block | string | false | none | none |
| typeahead_css_block | string | false | none | none |
| custom_questions | object | false | none | none |
| facebook_pixel_id | string | false | none | none |
| lotame_client_id | string | false | none | none |
| qualtrics_zone_id | string¦null | false | none | none |
| qualtrics_brand_id | string¦null | false | none | none |
| enable_ddc_banners | boolean | false | none | none |
| enable_ddc_ctas | boolean | false | none | none |
| ddc_cta_type | string | false | none | Enum Description: default - Default primary - Primary |
| ddc_cta_launches_modal | boolean | false | none | none |
| enable_d2c_tracking | boolean | false | none | none |
| d2c_media_dealer_key | string¦null | false | none | none |
| disable_offer_missing_vin_to_consumer_email | boolean | false | none | none |
| disable_new_offer_to_consumer_email | boolean | false | none | none |
| disable_offer_no_value_to_consumer_email | boolean | false | none | none |
| enable_sms_offer_result_to_consumer | boolean | false | none | none |
| widget_domain_whitelist | [string] | true | none | none |
| marketplace_automation_buying | boolean¦null | false | none | none |
| dww_consumer_max_distance | integer¦null | false | none | none |
| restrict_leads_outside_service_area | boolean | false | read-only | none |
| dsa_consumer_max_distance | integer¦null | false | none | No value uses the DSA level limit, specifying a value will override the DSA level limit only if the specified value is smaller |
| enable_dsa_consumer_max_distance | boolean | false | none | none |
| dsa_consumer_exclude_states | [string] | false | read-only | none |
| enable_dsa_consumer_exclude_states | boolean | false | none | none |
| dsa_vehicle_exclude_makes | [string] | false | read-only | none |
| enable_dsa_vehicle_exclude_makes | boolean | false | none | none |
| dsa_vehicle_max_odometer | integer¦null | false | none | none |
| enable_dsa_vehicle_max_odometer | boolean | false | none | none |
| dsa_vehicle_offer_price_cap | integer¦null | false | none | none |
| enable_dsa_vehicle_offer_price_cap | boolean | false | none | none |
| complete_offer_push_async | boolean | false | read-only | none |
| ab_testing | object¦null | false | none | none |
| terms_and_conditions_url | string | false | read-only | none |
| support_phone_number | string | false | read-only | none |
| support_email | string | false | read-only | none |
| dealer_key | string | false | read-only | none |
| country_code | string | false | read-only | none |
| source_dealer_id | string | false | read-only | none |
| oem_name | string | false | read-only | none |
| oem_dealer_id | string | false | read-only | none |
| oem_sub_brand | string | false | read-only | none |
| oem_tier_id | string | false | read-only | none |
| oem_analytics_vendor | string | false | read-only | none |
| oem_analytics_id | string | false | read-only | none |
| oem_analytics_provider_id | string | false | read-only | none |
| oem_analytics_url_stage | string | false | read-only | none |
| oem_analytics_url_prod | string | false | read-only | none |
| dealership_name | string | false | read-only | none |
| dealership_region | string | false | read-only | none |
| dealership_group | string | false | read-only | none |
| primary_contact_phone | string | false | read-only | none |
| consumer_env_base_url | string | true | none | none |
| embed_snippet | string | false | read-only | none |
| typeahead_widget_embed_snippet | string | false | read-only | none |
| typeahead_drawer_embed_snippet | string | false | read-only | none |
| typeahead_hero_embed_snippet | string | false | read-only | none |
| typeahead_headless_embed_snippet | string | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| pricing_country | usa |
| pricing_country | canada |
| ranged_or_gp | ranged |
| ranged_or_gp | gp |
| ranged_or_gp | disabled |
| ranged_or_gp | ranged_and_gp |
| ranged_or_gp | ymmt_gp |
| ranged_or_gp | single_page_ranged |
| show_oem_gtp | 1 |
| show_oem_gtp | 2 |
| dsa_lookup_type | voi |
| language_switch | menu |
| language_switch | inline |
| vehicle_entry_default | licensePlate |
| vehicle_entry_default | vin |
| vehicle_entry_default | ymmt |
| vehicle_entry_selector_shape | rounded |
| vehicle_entry_selector_shape | square |
| vehicle_entry_selector_shape | underline |
| color_selector_shape | rounded |
| color_selector_shape | square |
| color_selector_shape | underline |
| cta_button_shape | rounded |
| cta_button_shape | square |
| cta_button_shape | underline |
| option_button_shape | rounded |
| option_button_shape | square |
| option_button_shape | underline |
| optional_photos_location | vehicle-details-top |
| optional_photos_location | vehicle-details-bottom |
| assumptions_location | top |
| assumptions_location | bottom |
| price_review_sequencing | high |
| price_review_sequencing | low |
| comparable_vehicles_display | both |
| comparable_vehicles_display | graph |
| comparable_vehicles_display | map |
| comparable_vehicles_display | list |
| comparable_vehicles_summary | both |
| comparable_vehicles_summary | text |
| offer_header | original |
| offer_header | alt-a |
| offer_ready_to_sell | original |
| offer_ready_to_sell | alt-a |
| typeahead_widget_drawer_handle_position | left |
| typeahead_widget_drawer_handle_position | center |
| typeahead_widget_drawer_handle_position | right |
| ddc_cta_type | default |
| ddc_cta_type | primary |
Dealership
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
| preferences | Preferences | false | none | none |
| partner | string | true | none | none |
| branding | string¦null | false | none | none |
| product | string | true | none | none |
| company | integer | true | none | none |
| in_partner_dsa | boolean¦null | false | read-only | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| name | string | true | none | none |
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
| partner_dealer_id | string¦null | true | none | none |
| oem_name | string¦null | false | none | none |
| oem_dealer_id | string¦null | false | none | none |
| oem_dealer_id2 | string¦null | false | none | none |
| oem_sub_brand | string¦null | false | none | none |
| friendly_name | string¦null | false | none | none |
| friendly_phone | string¦null | false | none | none |
| primary_contact_name | string¦null | false | none | none |
| primary_contact_phone | string¦null | false | none | none |
| primary_contact_email | string(email) | true | none | none |
| primary_contact_title | string | false | none | none |
| primary_contact_image | string | false | none | none |
| lead_primary_contact_name | string¦null | false | none | none |
| lead_primary_contact_phone | string¦null | false | none | none |
| lead_primary_contact_email | string¦null | false | none | none |
| dealer_image | string | false | none | none |
| profile_url | string | false | none | none |
| uuid | string | false | none | none |
| country | integer¦null | false | none | Enum Description: 1 - USA 2 - Canada |
| source_id | string¦null | false | none | none |
| source_type | integer¦null | false | none | none |
| expiration_date | string(date-time)¦null | false | none | none |
| adf_user_id | string¦null | false | none | none |
| disable_partner_events | boolean | false | none | Disable related partner or system events when the offer is associated with this dealership |
| user | integer¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| country | 1 |
| country | 2 |
User
{
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| last_login | string(date-time)¦null | false | none | none |
| is_superuser | boolean | false | read-only | Designates that this user has all permissions without explicitly assigning them. |
| username | string | false | read-only | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
| first_name | string | false | none | none |
| last_name | string | false | none | none |
| string(email) | false | none | none | |
| is_active | boolean | false | none | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
| date_joined | string(date-time) | false | none | none |
Staff
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
| user | User | true | none | none |
| profile_picture | Media | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
| cell_phone | string¦null | false | none | none |
| home_phone | string¦null | false | none | none |
| first_name | string¦null | false | none | none |
| last_name | string¦null | false | none | none |
| string¦null | false | none | none | |
| receives_pending_email | boolean | false | none | none |
| hvms_buyer_code | string¦null | false | none | none |
| description | string | false | none | none |
| show_in_dealer_list | boolean | false | none | none |
| role | integer | false | none | Enum Description: 200 - Admin 100 - Manager 1 - Staff 0 - CSR (Read Only) |
| is_on_call | boolean | false | none | none |
| company | integer | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| role | 200 |
| role | 100 |
| role | 1 |
| role | 0 |
System
{
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time)¦null | false | none | none |
| name | string | true | none | none |
| slug | string(slug) | false | read-only | none |
| generates_offer_type | string | false | none | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| origin_type_name | string¦null | false | none | none |
| generates_multiple_offers | boolean | false | none | none |
| does_report_events | boolean | false | none | none |
| lead_source_label | string¦null | false | none | Overrides default lead source label |
| user | integer | false | none | none |
| dealer_group | integer¦null | false | none | none |
| company | integer | false | none | none |
| partner | integer | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| generates_offer_type | consumer |
| generates_offer_type | dealer |
| generates_offer_type | algol |
OfferDetail
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"dealer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"original_range": "string",
"boosted_offer_range_low": 0,
"boosted_offer_range_high": 0,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
],
"loan_payoff": 0,
"loan_equity": 0,
"has_uploaded_photo_incentive": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
| code | string(uuid) | false | read-only | none |
| offer_short_code | string | false | read-only | none |
| vacs | [OfferVac] | false | none | none |
| media | OfferMedia | false | none | none |
| consumer | OfferDetailConsumer | true | none | none |
| vehicle_price | integer | false | read-only | none |
| vehicle_price_adjustment | integer | false | read-only | none |
| vehicle_offer_price | integer | false | read-only | none |
| vehicle_image | string¦null | false | none | none |
| additional_images | [string] | false | none | none |
| vehicle_color_hex | string¦null | false | none | none |
| vehicle_specialized | boolean | false | read-only | none |
| expired | boolean | false | read-only | none |
| uuid | string | false | none | none |
| vdpid | string | false | none | none |
| odid | string | false | none | none |
| needs_dealer_review | boolean | false | read-only | none |
| dealer_tax_savings | integer | false | read-only | none |
| dealer_sale_time | string | false | read-only | none |
| private_sale_time | string | false | read-only | none |
| private_expected_depreciation | number | false | read-only | none |
| private_tax_savings | string | false | read-only | none |
| state_tax | number | false | read-only | none |
| untaxed_amount | integer | false | read-only | none |
| assigned_dealerships | [integer] | false | read-only | none |
| expiration_date | string(date-time) | false | read-only | none |
| is_over_mileage | boolean | false | read-only | none |
| equity_lender | string¦null | false | none | none |
| price_review_reason | integer | false | read-only | Enum Description: 1 - Still Considering 2 - Expected a Higher Price 3 - Not Ready To Sell 4 - Other 5 - Received Better Offer 6 - Selling Privately |
| custom_questions | object | false | none | none |
| custom_notes | string | false | none | none |
| extras | object¦null | false | none | none |
| expanded_data | object¦null | false | read-only | none |
| ab_variant | string¦null | false | none | none |
| host_domain | string¦null | false | none | none |
| host_url | string¦null | false | none | none |
| new_vehicle_vin | string¦null | false | none | none |
| new_vehicle_stock_number | string¦null | false | none | none |
| new_vehicle_odometer | string¦null | false | none | none |
| transportation_dropoff_location | string¦null | false | none | none |
| vehicle_color | Color | true | none | none |
| vehicle_interior_color | Color | true | none | none |
| dealer | Dealership | true | none | none |
| supervisor | Staff | true | none | none |
| source_system | System | true | none | none |
| accutrade_url | string | true | none | none |
| google_search_url | string | true | none | none |
| marketcheck_url | string | true | none | none |
| mmr_url | string | true | none | none |
| original_range | string | false | read-only | none |
| boosted_offer_range_low | integer¦null | false | read-only | none |
| boosted_offer_range_high | integer¦null | false | read-only | none |
| price_review_feedback_date | string(date) | false | read-only | none |
| price_review_feedback_price | integer | false | read-only | none |
| price_review_feedback | string | false | read-only | none |
| price_review_feedback_conditions | [string] | false | read-only | none |
| loan_payoff | number(decimal) | true | none | none |
| loan_equity | number(decimal) | true | none | none |
| has_uploaded_photo_incentive | boolean | false | read-only | none |
| created | string(date-time) | false | read-only | none |
| vehicle_mismatch | boolean¦null | false | read-only | none |
| vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| vehicle_source_id | string¦null | false | none | none |
| vehicle_vin | string¦null | false | none | none |
| vehicle_year | integer | false | none | none |
| vehicle_make | string | false | none | none |
| vehicle_model | string | false | none | none |
| vehicle_style | string | false | none | none |
| modified | string(date-time) | false | read-only | none |
| origin_offer_code | string | false | none | none |
| type | string | false | read-only | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| pricing_type | string | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price estimate - Estimate ymmt_gp - YMMT Guaranteed Price |
| vin_to_value | boolean¦null | false | none | none |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| source_system_record_id | string¦null | false | none | none |
| key_fobs | integer¦null | false | none | none |
| key_fobs_adjustment | integer | false | read-only | none |
| has_odor | boolean¦null | false | none | none |
| title_status | integer¦null | false | none | Enum Description: 1 - In hand 10 - Payoff 20 - Other |
| is_salvage_title | boolean¦null | false | none | none |
| salvage_title_adjustment | integer | false | read-only | none |
| is_rebuilt_title | boolean¦null | false | none | none |
| is_original_owner | boolean¦null | false | none | none |
| is_liened | boolean¦null | false | none | none |
| is_leased | boolean¦null | false | none | none |
| owed_amount | integer¦null | false | none | none |
| has_accident | boolean¦null | false | none | none |
| vehicle_includes | string¦null | false | none | none |
| vehicle_mileage | integer¦null | false | none | none |
| vehicle_base_miles | integer¦null | false | read-only | none |
| vehicle_trade_price | integer¦null | false | none | none |
| vehicle_market_price | integer¦null | false | none | none |
| vehicle_base_price | integer¦null | false | none | none |
| vehicle_price_was_adjusted | boolean | false | none | none |
| vehicle_odor_adjustment | integer | false | read-only | none |
| vehicle_engine_type | string¦null | false | none | none |
| mileage_adjustment | integer | false | read-only | none |
| postal_code_adjustment | integer | false | read-only | none |
| color_adjustment | integer | false | read-only | none |
| transportation_pickup | boolean¦null | false | none | none |
| is_consumer_clickthru | boolean¦null | false | read-only | none |
| chrome_body_id | integer¦null | false | none | none |
| chrome_style_id | integer¦null | false | none | none |
| chrome_body_style | string¦null | false | none | none |
| chrome_engine_size | string¦null | false | none | none |
| negotiated_price | number(decimal)¦null | false | read-only | none |
| dealer_accepted | boolean | false | read-only | none |
| trade_desk_accepted | boolean | false | read-only | none |
| auto_advanced | boolean | false | read-only | none |
| send_to_marketplace | boolean | false | none | none |
| output_system_path | string | false | read-only | none |
| is_interested_new_vehicle | boolean¦null | false | none | none |
| new_vehicle_year | integer¦null | false | none | none |
| new_vehicle_make | string¦null | false | none | none |
| new_vehicle_model | string¦null | false | none | none |
| new_vehicle_style | string¦null | false | none | none |
| new_vehicle_source_id | string¦null | false | none | none |
| new_vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| new_vehicle_type | string¦null | false | none | Enum Description: new - New used - Used cpo - CPO undecided - Not Sure |
| has_modifications_aftermarket_kit | boolean¦null | false | none | none |
| insurance_payout_amount | number(decimal)¦null | false | none | none |
| insurance_payout_adjustment | integer | false | read-only | none |
| has_external_damage | boolean¦null | false | none | none |
| external_damage_amount | number(decimal)¦null | false | none | none |
| has_frame_damage | boolean¦null | false | none | none |
| frame_damage_adjustment | integer | false | read-only | none |
| front_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| rear_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| liened_type | string¦null | false | none | Enum Description: loan - Loan lease - Lease |
| lease_monthly_payment | number(decimal)¦null | false | none | none |
| lease_number_payments | integer¦null | false | none | none |
| lease_amount_remaining | number(decimal)¦null | false | none | none |
| did_agree_to_tos | boolean | false | none | none |
| range_low | integer¦null | false | read-only | none |
| range_high | integer¦null | false | read-only | none |
| guaranteed_price | integer¦null | false | read-only | none |
| boosted_offer_price | integer¦null | false | read-only | none |
| offer_posted_time | string(date-time)¦null | false | none | none |
| is_dsa_offer | boolean¦null | false | read-only | none |
| does_report_events | boolean¦null | false | read-only | none |
| plate_state | string¦null | false | none | none |
| plate_number | string¦null | false | none | none |
| has_warning_lights | boolean¦null | false | none | none |
| has_warning_lights_4x4 | boolean¦null | false | none | none |
| has_warning_lights_ac | boolean¦null | false | none | none |
| has_warning_lights_abs | boolean¦null | false | none | none |
| has_warning_lights_airbag | boolean¦null | false | none | none |
| has_warning_lights_battery | boolean¦null | false | none | none |
| has_warning_lights_brake | boolean¦null | false | none | none |
| has_warning_lights_engine | boolean¦null | false | none | none |
| has_warning_lights_suspension_fault | boolean¦null | false | none | none |
| has_warning_lights_srs | boolean¦null | false | none | none |
| has_warning_lights_tpms | boolean¦null | false | none | none |
| has_warning_lights_traction_control | boolean¦null | false | none | none |
| has_modifications | boolean¦null | false | none | none |
| has_modifications_exhaust | boolean¦null | false | none | none |
| has_modifications_catalytic_converter | boolean¦null | false | none | none |
| has_modifications_performance | boolean¦null | false | none | none |
| has_modifications_stereo | boolean¦null | false | none | none |
| has_modifications_spoiler | boolean¦null | false | none | none |
| has_modifications_suspension_lowered | boolean¦null | false | none | none |
| has_modifications_suspension_lifted | boolean¦null | false | none | none |
| has_modifications_sunroof_moonroof | boolean¦null | false | none | none |
| has_modifications_wheel | boolean¦null | false | none | none |
| has_aftermarket_tint | boolean¦null | false | none | none |
| has_mechanical_issues | boolean¦null | false | none | none |
| has_mechanical_sunroof_moonroof | boolean¦null | false | none | none |
| has_mechanical_suspension | boolean¦null | false | none | none |
| has_mechanical_brakes | boolean¦null | false | none | none |
| has_mechanical_engine | boolean¦null | false | none | none |
| has_mechanical_exhaust | boolean¦null | false | none | none |
| has_mechanical_transmission | boolean¦null | false | none | none |
| has_mechanical_ac | boolean¦null | false | none | none |
| has_mechanical_oil_leak | boolean¦null | false | none | none |
| has_mechanical_head_gasket | boolean¦null | false | none | none |
| has_mechanical_catalytic_converter | boolean¦null | false | none | none |
| has_mechanical_other | boolean¦null | false | none | none |
| mechanical_other_note | string | false | none | none |
| has_other_issues | boolean¦null | false | none | none |
| has_flood_damage | boolean¦null | false | none | none |
| has_fire_damage | boolean¦null | false | none | none |
| has_hail_damage | boolean¦null | false | none | none |
| was_stolen | boolean¦null | false | none | none |
| has_unnamed_issue | boolean¦null | false | none | none |
| other_issues_repair_cost | number(decimal)¦null | false | none | none |
| has_significant_issues | boolean¦null | false | none | none |
| damage_panels | object¦null | false | none | none |
| add_optional_photos | boolean¦null | false | none | none |
| expect_transact_months | integer¦null | false | none | Enum Description: 0 - Ready to sell now 2 - 2 - 6 months 100 - Curious |
| price_review_vote | boolean¦null | false | read-only | none |
| vdp | string¦null | false | none | none |
| cid | string¦null | false | none | none |
| origin_type | string¦null | false | none | none |
| origin_ip | string¦null | false | read-only | none |
| offer_view_url | string | false | none | none |
| pricing_country | integer | false | read-only | Enum Description: 1 - United States 2 - Canada |
| condition_report_path | string¦null | false | read-only | none |
| consumer_offer_expiration_period | integer | false | read-only | none |
| dealer_offer_expiration_period | integer | false | read-only | none |
| approximate_condition | string¦null | false | none | Enum Description: excellent - Excellent good - Good fair - Fair poor - Poor |
| single_page_workflow | boolean | false | none | none |
| vhr_data | object¦null | false | read-only | none |
| carfax_accident_reported | boolean¦null | false | read-only | none |
| carfax_num_previous_owners | integer¦null | false | read-only | none |
| carfax_expected_mileage | integer¦null | false | read-only | none |
| carfax_last_reported_mileage | integer¦null | false | read-only | none |
| carfax_has_salvaged_title_issue | boolean¦null | false | read-only | none |
| carfax_has_bad_vhr | boolean¦null | false | none | none |
| carfax_bad_vhr_adjustment | integer | false | read-only | none |
| lt | string¦null | false | none | none |
| visitor_uuid | string¦null | false | none | none |
| partner_offer_id | string¦null | false | none | none |
| offer_cert_link | string¦null | false | none | none |
| offer_return_link | string¦null | false | none | none |
| appraisal_id | string¦null | false | read-only | none |
| sirius_permalink | string¦null | false | read-only | none |
| pag_id | string¦null | false | none | none |
| pag_name | string¦null | false | none | none |
| pag_logo_url | string¦null | false | none | none |
| aff_cid | string¦null | false | none | none |
| lead_source | string¦null | false | none | Enum Description: leadstart_api - API leadstart_widget - Dealer Widget leadstart_banner - Typeahead Banner leadstart_drawer - Typeahead Drawer leadstart_hero - Typeahead Hero leadstart_heroba - Typeahead Hero Banner leadstart_hdless - Typeahead Headless |
| is_equity | boolean¦null | false | none | none |
| step_completion | integer¦null | false | none | none |
| is_testing | boolean | false | none | none |
| company | integer | false | read-only | none |
| partner | integer¦null | false | read-only | none |
| selected_dealerships | [integer] | false | read-only | none |
| vehicle_photos | [integer] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| price_review_reason | 1 |
| price_review_reason | 2 |
| price_review_reason | 3 |
| price_review_reason | 4 |
| price_review_reason | 5 |
| price_review_reason | 6 |
| vehicle_source | 1 |
| vehicle_source | 2 |
| vehicle_source | 3 |
| type | consumer |
| type | dealer |
| type | algol |
| pricing_type | ranged |
| pricing_type | gp |
| pricing_type | estimate |
| pricing_type | ymmt_gp |
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| title_status | 1 |
| title_status | 10 |
| title_status | 20 |
| new_vehicle_source | 1 |
| new_vehicle_source | 2 |
| new_vehicle_source | 3 |
| new_vehicle_type | new |
| new_vehicle_type | used |
| new_vehicle_type | cpo |
| new_vehicle_type | undecided |
| front_tire_age | poor |
| front_tire_age | good |
| front_tire_age | excellent |
| rear_tire_age | poor |
| rear_tire_age | good |
| rear_tire_age | excellent |
| liened_type | loan |
| liened_type | lease |
| expect_transact_months | 0 |
| expect_transact_months | 2 |
| expect_transact_months | 100 |
| pricing_country | 1 |
| pricing_country | 2 |
| approximate_condition | excellent |
| approximate_condition | good |
| approximate_condition | fair |
| approximate_condition | poor |
| lead_source | leadstart_api |
| lead_source | leadstart_widget |
| lead_source | leadstart_banner |
| lead_source | leadstart_drawer |
| lead_source | leadstart_hero |
| lead_source | leadstart_heroba |
| lead_source | leadstart_hdless |
OfferNotes
{
"id": 0,
"sender_type": "string",
"sender": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"message": "string",
"sender_role": 1,
"sender_name": "string",
"sender_phone": "string",
"sender_image": "string",
"amount": 0,
"offer": 0,
"sender_dealer": 0,
"sender_system": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| sender_type | string | false | read-only | none |
| sender | Staff | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time)¦null | false | none | none |
| message | string | true | none | none |
| sender_role | integer¦null | false | read-only | Enum Description: 1 - Company 2 - Processor 3 - Offer Manager |
| sender_name | string | false | none | none |
| sender_phone | string | false | none | none |
| sender_image | string | false | none | none |
| amount | number(decimal)¦null | false | none | none |
| offer | integer | true | none | none |
| sender_dealer | integer¦null | false | none | none |
| sender_system | integer¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| sender_role | 1 |
| sender_role | 2 |
| sender_role | 3 |
ALGolLease
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"lease_company": "string",
"end_date": "2019-08-24",
"loan_id": "string",
"vin": "stringstringstrin",
"trim": "string",
"options": [
{
"name": "string",
"selected": false
}
],
"offer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"dealer": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"preferences": {
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"pricing_country": "usa",
"single_page_workflow": true,
"combined_details_conditions_page": true,
"digital_retail_experience": true,
"digital_retail_uuid_configs": true,
"show_pii_for_digital_retail": true,
"hide_digital_retail_offer_page": true,
"root_branding_enabled": true,
"accu_trade_appraiser": true,
"ranged_or_gp": "ranged",
"vin_to_value_enabled": true,
"autocheck_vhr_disabled": true,
"autocheck_hide_questions": true,
"pricing_boost_to_market": true,
"voi_required": true,
"show_oem_gtp": 1,
"bypass_no_value_check": true,
"low_value_dealer_review": true,
"combined_dcp_enabled": true,
"combined_dcp_simplified_header": true,
"enable_condensed_conditions": true,
"show_dealer_group_dropdown": true,
"dsa_lookup_type": "voi",
"preferred_language": "string",
"supported_languages": [
"string"
],
"show_language_switch": true,
"language_switch": "menu",
"content_pieces": "string",
"tax_discount": 0,
"google_tracker": "string",
"google_conversion": "string",
"google_conversion_id": "string",
"google_conversion_label": "string",
"google_conversion_id_consumer_engagement": "string",
"google_conversion_label_consumer_engagement": "string",
"google_tag_manager_id": "string",
"has_ga4_measurement_config": "string",
"ga4_measurement_ids": {},
"enable_send_to": true,
"offer_view_base_url": "string",
"appointment_email": "user@example.com",
"appointment_contact": "string",
"advanced_offer_lead_selection": true,
"dsa_enabled": "string",
"is_utf7": true,
"crm_leads": [
{
"id": 0,
"type": "string",
"format": "string",
"target": "string",
"lead_source": "string",
"lead_source_types": [
"dsa"
],
"email": "user@example.com",
"phone": "string",
"api_url": "http://example.com",
"api_data": {},
"name": "string",
"lead_source_type": "dsa",
"lead_identifier": "string",
"descriptor": "string",
"provider": "string",
"provider_service": "string"
}
],
"facilitation_location": {
"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact": "string",
"instructions": "string"
},
"replacement_vehicle": true,
"show_new": true,
"show_used": true,
"show_cpo": true,
"replacement_vehicle_makes": "string",
"voi_trim_required": "string",
"consumer_offer_expiration_period": -2147483648,
"dealer_offer_expiration_period": -2147483648,
"banner_url": "string",
"mobile_banner_url": "string",
"logo_url": "string",
"logo_url_driveway": "string",
"vehicle_entry_default": "licensePlate",
"deemphasize_vehicle_entry_ymmt": true,
"vehicle_entry_selector_shape": "rounded",
"color_selector_shape": "rounded",
"cta_button_shape": "rounded",
"option_button_shape": "rounded",
"hide_original_owner": true,
"hide_zip_code_field": true,
"hide_zip_code_field_on_pii": true,
"enable_geolocation": true,
"enable_advanced_color_selector": true,
"hide_vehicle_color_selector": true,
"hide_interior_color_selector": true,
"hide_vin_field": true,
"show_tax_savings_on_pii_page": true,
"suppress_address": true,
"expand_offer_condition_details": true,
"hide_offer_tax_savings": true,
"incorporate_tax_savings": true,
"hide_offer_breakdown": true,
"hide_offer_next_steps": true,
"hide_offer_dealer_contact_section": true,
"hide_vehicle_estimate_header": true,
"vehicle_estimate_header_text_color": "string",
"hide_footer": true,
"hide_how_it_works": true,
"hide_home_header": true,
"hide_header_price_during_survey": true,
"show_header_video": true,
"show_system_alert": true,
"show_estimate_condition": true,
"show_estimate_cell_phone": true,
"hide_estimate_original_owner": true,
"estimate_replacement_vehicle": true,
"hide_plate_to_vin": true,
"plate_to_vin_state_geolocation": true,
"show_keys_question": true,
"show_estimate_is_liened": true,
"show_gp_is_liened": true,
"show_gp_cell_phone": true,
"hide_gp_ymmt_fields": true,
"hide_pii_step": true,
"hide_last_name_field": true,
"hide_email_field": true,
"show_member_identifier": true,
"show_expected_transaction": true,
"show_best_time_to_contact": true,
"show_notes_entry": true,
"show_phone_verification": true,
"show_photo_upload_on_offer": true,
"show_estimate_photo_upload_on_offer": true,
"expand_photo_upload_on_offer": true,
"enable_photo_guidance": true,
"show_optional_photos": true,
"optional_photos_required": true,
"optional_photos_location": "vehicle-details-top",
"assumptions_location": "top",
"enable_editable_assumptions": true,
"show_price_review": true,
"price_review_sequencing": "high",
"show_comparable_vehicles": true,
"hide_comparable_vehicles_spread_table": true,
"comparable_vehicles_display": "both",
"comparable_vehicles_displays": [
"both"
],
"comparable_vehicles_summary": "both",
"show_equity_payout_on_offer": true,
"show_equity_payout_on_detail": true,
"show_single_value_offer_estimate": true,
"offer_header": "original",
"offer_ready_to_sell": "original",
"offer_ready_alt_background_color": "string",
"offer_ready_alt_text_color": "string",
"offer_ready_alt_primary_button_color": "string",
"offer_ready_alt_primary_button_text_color": "string",
"offer_ready_alt_secondary_button_color": "string",
"offer_ready_alt_secondary_button_text_color": "string",
"offer_ready_alt_secondary_button_border_color": "string",
"use_submitted_vehicle_image": true,
"should_send_to_showroom_leads": true,
"cell_phone_optional": true,
"show_branded_banner": true,
"show_confirmation_hero": true,
"hide_contact_cta_on_offer": true,
"show_offer_html_block": true,
"hide_vin_field_on_registration": true,
"enable_context_price_display": true,
"disable_focus_outline": true,
"focus_outline_color": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"widget_enable_host_tracking": true,
"banner_color": "string",
"cert_banner_color": "string",
"cert_compare_background_color": "string",
"cert_summary_background_color": "string",
"cert_summary_text_color": "string",
"cert_summary_separator_color": "string",
"default_text_color": "string",
"deemphasized_text_color": "string",
"heading_text_color": "string",
"footer_background_color": "string",
"footer_text_color": "string",
"footer_link_color": "string",
"link_color": "string",
"vehicle_entry_selector_border_color": "string",
"vehicle_entry_selector_button_fill_color": "string",
"vehicle_entry_selector_text_color": "string",
"vehicle_entry_selector_selected_text_color": "string",
"enable_ymmt_column_layout": true,
"enable_alt_trim_selection": true,
"option_selection_color": "string",
"option_button_text_color": "string",
"option_button_selected_text_color": "string",
"option_button_unselected_border_color": "string",
"primary_button_background_color": "string",
"primary_button_text_color": "string",
"secondary_button_background_color": "string",
"secondary_button_text_color": "string",
"secondary_button_border_color": "string",
"separator_color": "string",
"primary_header_text_color": "string",
"step_info_header_background_color": "string",
"step_info_header_text_color": "string",
"section_background_color": "string",
"autocheck_message_text_color": "string",
"autocheck_message_background_color": "string",
"autocheck_message_border_color": "string",
"autocheck_warn_background_color": "string",
"autocheck_warn_icon_color": "string",
"tab_color": "string",
"tab_separator_color": "string",
"details_conditions_separator_color": "string",
"form_field_placeholder_color": "string",
"form_field_title_color": "string",
"form_field_text_color": "string",
"form_field_border_color": "string",
"negative_value_color": "string",
"positive_value_color": "string",
"form_checkbox_color": "string",
"form_checkbox_unselected_color": "string",
"offer_condition_label_color": "string",
"offer_condition_value_color": "string",
"widget_google_font_import": "string",
"font_family": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"show_uploaded_photo_incentive": true,
"photo_incentive_value": 65535,
"css_block": "string",
"typeahead_css_block": "string",
"custom_questions": {},
"facebook_pixel_id": "string",
"lotame_client_id": "string",
"qualtrics_zone_id": "string",
"qualtrics_brand_id": "string",
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"enable_d2c_tracking": true,
"d2c_media_dealer_key": "string",
"disable_offer_missing_vin_to_consumer_email": true,
"disable_new_offer_to_consumer_email": true,
"disable_offer_no_value_to_consumer_email": true,
"enable_sms_offer_result_to_consumer": true,
"widget_domain_whitelist": [
"string"
],
"marketplace_automation_buying": true,
"dww_consumer_max_distance": 65535,
"restrict_leads_outside_service_area": true,
"dsa_consumer_max_distance": 65535,
"enable_dsa_consumer_max_distance": true,
"dsa_consumer_exclude_states": [
"string"
],
"enable_dsa_consumer_exclude_states": true,
"dsa_vehicle_exclude_makes": [
"string"
],
"enable_dsa_vehicle_exclude_makes": true,
"dsa_vehicle_max_odometer": 4294967295,
"enable_dsa_vehicle_max_odometer": true,
"dsa_vehicle_offer_price_cap": 4294967295,
"enable_dsa_vehicle_offer_price_cap": true,
"complete_offer_push_async": true,
"ab_testing": {},
"terms_and_conditions_url": "string",
"support_phone_number": "string",
"support_email": "string",
"dealer_key": "string",
"country_code": "string",
"source_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_sub_brand": "string",
"oem_tier_id": "string",
"oem_analytics_vendor": "string",
"oem_analytics_id": "string",
"oem_analytics_provider_id": "string",
"oem_analytics_url_stage": "string",
"oem_analytics_url_prod": "string",
"dealership_name": "string",
"dealership_region": "string",
"dealership_group": "string",
"primary_contact_phone": "string",
"consumer_env_base_url": "string",
"embed_snippet": "string",
"typeahead_widget_embed_snippet": "string",
"typeahead_drawer_embed_snippet": "string",
"typeahead_hero_embed_snippet": "string",
"typeahead_headless_embed_snippet": "string"
},
"partner": "string",
"branding": "string",
"product": "string",
"company": 0,
"in_partner_dsa": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"partner_dealer_id": "string",
"oem_name": "string",
"oem_dealer_id": "string",
"oem_dealer_id2": "string",
"oem_sub_brand": "string",
"friendly_name": "string",
"friendly_phone": "string",
"primary_contact_name": "string",
"primary_contact_phone": "string",
"primary_contact_email": "user@example.com",
"primary_contact_title": "string",
"primary_contact_image": "string",
"lead_primary_contact_name": "string",
"lead_primary_contact_phone": "string",
"lead_primary_contact_email": "string",
"dealer_image": "string",
"profile_url": "string",
"uuid": "string",
"country": 1,
"source_id": "string",
"source_type": -2147483648,
"expiration_date": "2019-08-24T14:15:22Z",
"adf_user_id": "string",
"disable_partner_events": true,
"user": 0
},
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"accutrade_url": "string",
"google_search_url": "string",
"marketcheck_url": "string",
"mmr_url": "string",
"original_range": "string",
"boosted_offer_range_low": 0,
"boosted_offer_range_high": 0,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
],
"loan_payoff": 0,
"loan_equity": 0,
"has_uploaded_photo_incentive": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
},
"first_name": "string",
"email": "user@example.com",
"messages": [
{
"id": 0,
"sender_type": "string",
"sender": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"message": "string",
"sender_role": 1,
"sender_name": "string",
"sender_phone": "string",
"sender_image": "string",
"amount": 0,
"offer": 0,
"sender_dealer": 0,
"sender_system": 0
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uuid | string(uuid) | false | read-only | none |
| lease_company | string | true | none | none |
| end_date | string(date) | true | none | none |
| loan_id | string | true | none | none |
| vin | string | true | none | none |
| trim | string¦null | false | none | none |
| options | [ALGolLeaseOption]¦null | false | none | none |
| offer | OfferDetail | false | none | none |
| first_name | string | true | none | none |
| string(email) | true | none | none | |
| messages | [OfferNotes] | false | read-only | none |
ALGolLeaseCSVUpload
{
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"lease_company": "string",
"csv_file": "http://example.com",
"dry_run": true,
"status": 0,
"result": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uuid | string(uuid) | false | read-only | none |
| lease_company | string | true | none | none |
| csv_file | string(uri) | false | read-only | none |
| dry_run | boolean | false | none | none |
| status | integer | false | read-only | none |
| result | object | false | read-only | none |
ContentPiece
{
"id": 0,
"key": "string",
"value": "string",
"default": false,
"language": "en",
"label": "string",
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"configuration": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| key | string | true | none | none |
| value | string | false | none | none |
| default | boolean | false | none | none |
| language | string | false | none | none |
| label | string¦null | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| configuration | integer¦null | true | none | none |
Lender
{
"name": "string",
"lender_id": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| lender_id | string | true | none | none |
Country
{
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| name | string | true | none | none |
| short_name | string | true | none | none |
| slug | string(slug) | false | read-only | none |
State
{
"id": 0,
"country": {
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
},
"name": "string",
"short_name": "st",
"slug": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| country | Country | true | none | none |
| name | string | true | none | none |
| short_name | string | true | none | none |
| slug | string(slug) | false | read-only | none |
PostalCode
{
"postal_code": "string",
"state": {
"id": 0,
"country": {
"id": 0,
"name": "string",
"short_name": "st",
"slug": "string"
},
"name": "string",
"short_name": "st",
"slug": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| postal_code | string | true | none | none |
| state | State | true | none | none |
ConsumerValidation
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| first_name | string¦null | false | none | none |
| last_name | string¦null | false | none | none |
| string¦null | false | none | none | |
| cell_phone | string¦null | false | none | none |
DealershipSearch
{
"uuid": "string",
"name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| uuid | string | false | none | none |
| name | string | true | none | none |
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
ContentConfiguration
{
"en": {},
"fr": {},
"es": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| en | object | false | read-only | none |
| fr | object | false | read-only | none |
| es | object | false | read-only | none |
TypeaheadPreferences
{
"id": 0,
"partner_identifier": "string",
"branding_identifier": "string",
"ranged_or_gp": "ranged",
"preferred_language": "string",
"country_code": "string",
"widget_google_font_import": "string",
"typeahead_widget_banner_color": "string",
"typeahead_widget_banner_font_color": "string",
"typeahead_widget_banner_font_family": "string",
"typeahead_widget_banner_font_size": "string",
"typeahead_widget_banner_height": 65535,
"typeahead_widget_banner_mobile_height": 65535,
"typeahead_widget_banner_background": "string",
"typeahead_widget_banner_mobile_background": "string",
"typeahead_drawer_color": "string",
"typeahead_drawer_font_color": "string",
"typeahead_drawer_font_family": "string",
"typeahead_drawer_font_size": "string",
"typeahead_drawer_handle_color": "string",
"typeahead_drawer_handle_text_color": "string",
"typeahead_widget_drawer_handle_height": 65535,
"typeahead_widget_drawer_handle_position": "left",
"typeahead_drawer_force_ontop": true,
"typeahead_hero_color": "string",
"typeahead_hero_font_color": "string",
"typeahead_hero_font_family": "string",
"typeahead_hero_font_size": "string",
"typeahead_widget_hero_banner_color": "string",
"typeahead_widget_hero_banner_text_color": "string",
"widget_banner_hide_logo": true,
"widget_drawer_hide_logo": true,
"widget_enable_host_tracking": true,
"enable_ddc_banners": true,
"enable_ddc_ctas": true,
"ddc_cta_type": "default",
"ddc_cta_launches_modal": true,
"env_base_url": "string",
"consumer_env_base_url": "string",
"offer_view_base_url": "string",
"disable_page_change_scroll": true,
"page_change_scroll_offset_desktop": -2147483648,
"page_change_scroll_offset_mobile": -2147483648,
"disable_history_state": true,
"typeahead_css_block": "string",
"content_configuration": {}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| partner_identifier | string | false | none | none |
| branding_identifier | string | false | read-only | none |
| ranged_or_gp | string¦null | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price disabled - Disabled ranged_and_gp - Ranged and Guaranteed Price ymmt_gp - YMMT Guaranteed Price single_page_ranged - Single Page Ranged |
| preferred_language | string | false | read-only | none |
| country_code | string | false | read-only | none |
| widget_google_font_import | string | false | none | none |
| typeahead_widget_banner_color | string¦null | false | none | none |
| typeahead_widget_banner_font_color | string¦null | false | none | none |
| typeahead_widget_banner_font_family | string¦null | false | none | none |
| typeahead_widget_banner_font_size | string¦null | false | none | none |
| typeahead_widget_banner_height | integer¦null | false | none | none |
| typeahead_widget_banner_mobile_height | integer¦null | false | none | none |
| typeahead_widget_banner_background | string | false | none | none |
| typeahead_widget_banner_mobile_background | string | false | none | none |
| typeahead_drawer_color | string¦null | false | none | none |
| typeahead_drawer_font_color | string¦null | false | none | none |
| typeahead_drawer_font_family | string¦null | false | none | none |
| typeahead_drawer_font_size | string¦null | false | none | none |
| typeahead_drawer_handle_color | string¦null | false | none | none |
| typeahead_drawer_handle_text_color | string¦null | false | none | none |
| typeahead_widget_drawer_handle_height | integer¦null | false | none | none |
| typeahead_widget_drawer_handle_position | string¦null | false | none | Enum Description: left - Left center - Center right - Right |
| typeahead_drawer_force_ontop | boolean | false | none | none |
| typeahead_hero_color | string¦null | false | none | none |
| typeahead_hero_font_color | string¦null | false | none | none |
| typeahead_hero_font_family | string¦null | false | none | none |
| typeahead_hero_font_size | string¦null | false | none | none |
| typeahead_widget_hero_banner_color | string¦null | false | none | none |
| typeahead_widget_hero_banner_text_color | string¦null | false | none | none |
| widget_banner_hide_logo | boolean | false | none | none |
| widget_drawer_hide_logo | boolean | false | none | none |
| widget_enable_host_tracking | boolean | false | none | none |
| enable_ddc_banners | boolean | false | none | none |
| enable_ddc_ctas | boolean | false | none | none |
| ddc_cta_type | string | false | none | Enum Description: default - Default primary - Primary |
| ddc_cta_launches_modal | boolean | false | none | none |
| env_base_url | string | false | read-only | none |
| consumer_env_base_url | string | true | none | none |
| offer_view_base_url | string¦null | false | none | none |
| disable_page_change_scroll | boolean | false | none | none |
| page_change_scroll_offset_desktop | integer¦null | false | none | none |
| page_change_scroll_offset_mobile | integer¦null | false | none | none |
| disable_history_state | boolean¦null | false | none | none |
| typeahead_css_block | string | false | none | none |
| content_configuration | object | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| ranged_or_gp | ranged |
| ranged_or_gp | gp |
| ranged_or_gp | disabled |
| ranged_or_gp | ranged_and_gp |
| ranged_or_gp | ymmt_gp |
| ranged_or_gp | single_page_ranged |
| typeahead_widget_drawer_handle_position | left |
| typeahead_widget_drawer_handle_position | center |
| typeahead_widget_drawer_handle_position | right |
| ddc_cta_type | default |
| ddc_cta_type | primary |
Consumer
{
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| first_name | string¦null | false | none | none |
| last_name | string¦null | false | none | none |
| address1 | string¦null | false | none | none |
| address2 | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
| cell_phone | string¦null | false | none | none |
| home_phone | string¦null | false | none | none |
| string¦null | false | none | none | |
| best_time_to_contact | string¦null | false | none | Enum Description: 0 - Unknown 1 - Morning 2 - Afternoon 3 - Evening |
| preferred_contact_method | string¦null | false | none | Enum Description: phone - Phone email - Email |
| phone_verified | boolean¦null | false | none | none |
| bypass_validation | boolean | false | none | none |
| member_identifier | string¦null | false | none | none |
| sms_last_sent_at | string(date-time)¦null | false | read-only | none |
| profile_picture | Media | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| best_time_to_contact | 0 |
| best_time_to_contact | 1 |
| best_time_to_contact | 2 |
| best_time_to_contact | 3 |
| preferred_contact_method | phone |
| preferred_contact_method |
Offer
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
| code | string(uuid) | false | read-only | none |
| offer_short_code | string | false | read-only | none |
| vacs | [OfferVac] | false | none | none |
| media | OfferMedia | false | none | none |
| consumer | Consumer | false | none | none |
| vehicle_price | integer | false | read-only | none |
| vehicle_price_adjustment | integer | false | read-only | none |
| vehicle_offer_price | integer | false | read-only | none |
| vehicle_image | string¦null | false | none | none |
| additional_images | [string] | false | none | none |
| vehicle_color_hex | string¦null | false | none | none |
| latitude | number(decimal)¦null | false | none | none |
| longitude | number(decimal)¦null | false | none | none |
| vehicle_specialized | boolean | false | read-only | none |
| expired | boolean | false | read-only | none |
| uuid | string | false | none | none |
| vdpid | string | false | none | none |
| odid | string | false | none | none |
| needs_dealer_review | boolean | false | read-only | none |
| dealer_tax_savings | integer | false | read-only | none |
| dealer_sale_time | string | false | read-only | none |
| private_sale_time | string | false | read-only | none |
| private_expected_depreciation | number | false | read-only | none |
| private_tax_savings | string | false | read-only | none |
| state_tax | number | false | read-only | none |
| untaxed_amount | integer | false | read-only | none |
| assigned_dealerships | [integer] | false | read-only | none |
| expiration_date | string(date-time) | false | read-only | none |
| is_over_mileage | boolean | false | read-only | none |
| equity_lender | string¦null | false | none | none |
| price_review_reason | integer | false | read-only | Enum Description: 1 - Still Considering 2 - Expected a Higher Price 3 - Not Ready To Sell 4 - Other 5 - Received Better Offer 6 - Selling Privately |
| appraisal_ids | [integer] | false | read-only | none |
| copy_media_from_offer | string(uuid) | false | none | none |
| copy_media_from_urls | [string] | false | none | none |
| offer_started_at | string(date-time) | false | none | none |
| load_vhr_data | boolean | false | none | none |
| lead_path | string¦null | false | none | none |
| salesperson | string | false | none | none |
| driveway | string(uuid) | false | none | none |
| campaign | string | false | none | none |
| custom_questions | object | false | none | none |
| custom_notes | string | false | none | none |
| extras | object¦null | false | none | none |
| expanded_data | object¦null | false | read-only | none |
| ab_variant | string¦null | false | none | none |
| host_domain | string¦null | false | none | none |
| host_url | string¦null | false | none | none |
| new_vehicle_vin | string¦null | false | none | none |
| new_vehicle_stock_number | string¦null | false | none | none |
| new_vehicle_odometer | string¦null | false | none | none |
| transportation_dropoff_location | string¦null | false | none | none |
| ignore_expired | boolean | false | none | none |
| vehicle_match | boolean | false | none | When true, vehicle identifiers associated with the offer will be used to match to an AccuTrade vehicle. This includes vehicle_vin, plate_number/plate_state, chrome_style_id, or vehicle_year/vehicle_make/vehicle_model/vehicle_style. Please note that vehicle_style can always be provided to have more accurate results, for example you can pass vehicle_vin/vehicle_style. There is no guarantee the matched vehicle is accurate or the best available match. Your account must be enabled for this feature. |
| created | string(date-time) | false | read-only | none |
| vehicle_mismatch | boolean¦null | false | read-only | none |
| vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| vehicle_source_id | string¦null | false | none | none |
| vehicle_vin | string¦null | false | none | none |
| vehicle_year | integer | false | none | none |
| vehicle_make | string | false | none | none |
| vehicle_model | string | false | none | none |
| vehicle_style | string | false | none | none |
| modified | string(date-time) | false | read-only | none |
| origin_offer_code | string | false | none | none |
| type | string | false | read-only | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| pricing_type | string | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price estimate - Estimate ymmt_gp - YMMT Guaranteed Price |
| vin_to_value | boolean¦null | false | none | none |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| source_system_record_id | string¦null | false | none | none |
| key_fobs | integer¦null | false | none | none |
| key_fobs_adjustment | integer | false | read-only | none |
| has_odor | boolean¦null | false | none | none |
| title_status | integer¦null | false | none | Enum Description: 1 - In hand 10 - Payoff 20 - Other |
| is_salvage_title | boolean¦null | false | none | none |
| salvage_title_adjustment | integer | false | read-only | none |
| is_rebuilt_title | boolean¦null | false | none | none |
| is_original_owner | boolean¦null | false | none | none |
| is_liened | boolean¦null | false | none | none |
| is_leased | boolean¦null | false | none | none |
| owed_amount | integer¦null | false | none | none |
| has_accident | boolean¦null | false | none | none |
| vehicle_includes | string¦null | false | none | none |
| vehicle_mileage | integer¦null | false | none | none |
| vehicle_base_miles | integer¦null | false | read-only | none |
| vehicle_trade_price | integer¦null | false | none | none |
| vehicle_market_price | integer¦null | false | none | none |
| vehicle_base_price | integer¦null | false | none | none |
| vehicle_price_was_adjusted | boolean | false | none | none |
| vehicle_odor_adjustment | integer | false | read-only | none |
| vehicle_engine_type | string¦null | false | none | none |
| mileage_adjustment | integer | false | read-only | none |
| postal_code_adjustment | integer | false | read-only | none |
| color_adjustment | integer | false | read-only | none |
| transportation_pickup | boolean¦null | false | none | none |
| is_consumer_clickthru | boolean¦null | false | read-only | none |
| chrome_body_id | integer¦null | false | none | none |
| chrome_style_id | integer¦null | false | none | none |
| chrome_body_style | string¦null | false | none | none |
| chrome_engine_size | string¦null | false | none | none |
| negotiated_price | number(decimal)¦null | false | read-only | none |
| dealer_accepted | boolean | false | read-only | none |
| trade_desk_accepted | boolean | false | read-only | none |
| auto_advanced | boolean | false | read-only | none |
| send_to_marketplace | boolean | false | none | none |
| output_system_path | string | false | read-only | none |
| is_interested_new_vehicle | boolean¦null | false | none | none |
| new_vehicle_year | integer¦null | false | none | none |
| new_vehicle_make | string¦null | false | none | none |
| new_vehicle_model | string¦null | false | none | none |
| new_vehicle_style | string¦null | false | none | none |
| new_vehicle_source_id | string¦null | false | none | none |
| new_vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| new_vehicle_type | string¦null | false | none | Enum Description: new - New used - Used cpo - CPO undecided - Not Sure |
| has_modifications_aftermarket_kit | boolean¦null | false | none | none |
| insurance_payout_amount | number(decimal)¦null | false | none | none |
| insurance_payout_adjustment | integer | false | read-only | none |
| has_external_damage | boolean¦null | false | none | none |
| external_damage_amount | number(decimal)¦null | false | none | none |
| has_frame_damage | boolean¦null | false | none | none |
| frame_damage_adjustment | integer | false | read-only | none |
| front_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| rear_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| liened_type | string¦null | false | none | Enum Description: loan - Loan lease - Lease |
| lease_monthly_payment | number(decimal)¦null | false | none | none |
| lease_number_payments | integer¦null | false | none | none |
| lease_amount_remaining | number(decimal)¦null | false | none | none |
| did_agree_to_tos | boolean | false | none | none |
| range_low | integer¦null | false | read-only | none |
| range_high | integer¦null | false | read-only | none |
| guaranteed_price | integer¦null | false | read-only | none |
| boosted_offer_price | integer¦null | false | read-only | none |
| offer_posted_time | string(date-time)¦null | false | none | none |
| is_dsa_offer | boolean¦null | false | read-only | none |
| does_report_events | boolean¦null | false | read-only | none |
| plate_state | string¦null | false | none | none |
| plate_number | string¦null | false | none | none |
| has_warning_lights | boolean¦null | false | none | none |
| has_warning_lights_4x4 | boolean¦null | false | none | none |
| has_warning_lights_ac | boolean¦null | false | none | none |
| has_warning_lights_abs | boolean¦null | false | none | none |
| has_warning_lights_airbag | boolean¦null | false | none | none |
| has_warning_lights_battery | boolean¦null | false | none | none |
| has_warning_lights_brake | boolean¦null | false | none | none |
| has_warning_lights_engine | boolean¦null | false | none | none |
| has_warning_lights_suspension_fault | boolean¦null | false | none | none |
| has_warning_lights_srs | boolean¦null | false | none | none |
| has_warning_lights_tpms | boolean¦null | false | none | none |
| has_warning_lights_traction_control | boolean¦null | false | none | none |
| has_modifications | boolean¦null | false | none | none |
| has_modifications_exhaust | boolean¦null | false | none | none |
| has_modifications_catalytic_converter | boolean¦null | false | none | none |
| has_modifications_performance | boolean¦null | false | none | none |
| has_modifications_stereo | boolean¦null | false | none | none |
| has_modifications_spoiler | boolean¦null | false | none | none |
| has_modifications_suspension_lowered | boolean¦null | false | none | none |
| has_modifications_suspension_lifted | boolean¦null | false | none | none |
| has_modifications_sunroof_moonroof | boolean¦null | false | none | none |
| has_modifications_wheel | boolean¦null | false | none | none |
| has_aftermarket_tint | boolean¦null | false | none | none |
| has_mechanical_issues | boolean¦null | false | none | none |
| has_mechanical_sunroof_moonroof | boolean¦null | false | none | none |
| has_mechanical_suspension | boolean¦null | false | none | none |
| has_mechanical_brakes | boolean¦null | false | none | none |
| has_mechanical_engine | boolean¦null | false | none | none |
| has_mechanical_exhaust | boolean¦null | false | none | none |
| has_mechanical_transmission | boolean¦null | false | none | none |
| has_mechanical_ac | boolean¦null | false | none | none |
| has_mechanical_oil_leak | boolean¦null | false | none | none |
| has_mechanical_head_gasket | boolean¦null | false | none | none |
| has_mechanical_catalytic_converter | boolean¦null | false | none | none |
| has_mechanical_other | boolean¦null | false | none | none |
| mechanical_other_note | string | false | none | none |
| has_other_issues | boolean¦null | false | none | none |
| has_flood_damage | boolean¦null | false | none | none |
| has_fire_damage | boolean¦null | false | none | none |
| has_hail_damage | boolean¦null | false | none | none |
| was_stolen | boolean¦null | false | none | none |
| has_unnamed_issue | boolean¦null | false | none | none |
| other_issues_repair_cost | number(decimal)¦null | false | none | none |
| has_significant_issues | boolean¦null | false | none | none |
| damage_panels | object¦null | false | none | none |
| add_optional_photos | boolean¦null | false | none | none |
| expect_transact_months | integer¦null | false | none | Enum Description: 0 - Ready to sell now 2 - 2 - 6 months 100 - Curious |
| price_review_vote | boolean¦null | false | read-only | none |
| vdp | string¦null | false | none | none |
| cid | string¦null | false | none | none |
| origin_type | string¦null | false | none | none |
| origin_ip | string¦null | false | read-only | none |
| offer_view_url | string | false | none | none |
| pricing_country | integer | false | read-only | Enum Description: 1 - United States 2 - Canada |
| condition_report_path | string¦null | false | read-only | none |
| consumer_offer_expiration_period | integer | false | read-only | none |
| dealer_offer_expiration_period | integer | false | read-only | none |
| approximate_condition | string¦null | false | none | Enum Description: excellent - Excellent good - Good fair - Fair poor - Poor |
| single_page_workflow | boolean | false | none | none |
| vhr_data | object¦null | false | read-only | none |
| carfax_accident_reported | boolean¦null | false | read-only | none |
| carfax_num_previous_owners | integer¦null | false | read-only | none |
| carfax_expected_mileage | integer¦null | false | read-only | none |
| carfax_last_reported_mileage | integer¦null | false | read-only | none |
| carfax_has_salvaged_title_issue | boolean¦null | false | read-only | none |
| carfax_has_bad_vhr | boolean¦null | false | none | none |
| carfax_bad_vhr_adjustment | integer | false | read-only | none |
| lt | string¦null | false | none | none |
| visitor_uuid | string¦null | false | none | none |
| partner_offer_id | string¦null | false | none | none |
| offer_cert_link | string¦null | false | none | none |
| offer_return_link | string¦null | false | none | none |
| appraisal_id | string¦null | false | read-only | none |
| sirius_permalink | string¦null | false | read-only | none |
| pag_id | string¦null | false | none | none |
| pag_name | string¦null | false | none | none |
| pag_logo_url | string¦null | false | none | none |
| aff_cid | string¦null | false | none | none |
| lead_source | string¦null | false | none | Enum Description: leadstart_api - API leadstart_widget - Dealer Widget leadstart_banner - Typeahead Banner leadstart_drawer - Typeahead Drawer leadstart_hero - Typeahead Hero leadstart_heroba - Typeahead Hero Banner leadstart_hdless - Typeahead Headless |
| is_equity | boolean¦null | false | none | none |
| step_completion | integer¦null | false | none | none |
| is_testing | boolean | false | none | none |
| dealer | integer¦null | false | read-only | none |
| source_system | integer¦null | false | read-only | none |
| vehicle_color | integer¦null | false | none | none |
| vehicle_interior_color | integer¦null | false | none | none |
| supervisor | integer¦null | false | none | none |
| company | integer | false | read-only | none |
| partner | integer¦null | false | read-only | none |
| selected_dealerships | [integer] | false | read-only | none |
| vehicle_photos | [integer] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| price_review_reason | 1 |
| price_review_reason | 2 |
| price_review_reason | 3 |
| price_review_reason | 4 |
| price_review_reason | 5 |
| price_review_reason | 6 |
| vehicle_source | 1 |
| vehicle_source | 2 |
| vehicle_source | 3 |
| type | consumer |
| type | dealer |
| type | algol |
| pricing_type | ranged |
| pricing_type | gp |
| pricing_type | estimate |
| pricing_type | ymmt_gp |
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| title_status | 1 |
| title_status | 10 |
| title_status | 20 |
| new_vehicle_source | 1 |
| new_vehicle_source | 2 |
| new_vehicle_source | 3 |
| new_vehicle_type | new |
| new_vehicle_type | used |
| new_vehicle_type | cpo |
| new_vehicle_type | undecided |
| front_tire_age | poor |
| front_tire_age | good |
| front_tire_age | excellent |
| rear_tire_age | poor |
| rear_tire_age | good |
| rear_tire_age | excellent |
| liened_type | loan |
| liened_type | lease |
| expect_transact_months | 0 |
| expect_transact_months | 2 |
| expect_transact_months | 100 |
| pricing_country | 1 |
| pricing_country | 2 |
| approximate_condition | excellent |
| approximate_condition | good |
| approximate_condition | fair |
| approximate_condition | poor |
| lead_source | leadstart_api |
| lead_source | leadstart_widget |
| lead_source | leadstart_banner |
| lead_source | leadstart_drawer |
| lead_source | leadstart_hero |
| lead_source | leadstart_heroba |
| lead_source | leadstart_hdless |
OfferSerializerWithPush
{
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"media": {
"vehicle": {},
"service_records": [
{}
],
"modifications": [
{}
],
"accident": [
{}
],
"stock_image": {
"property1": "string",
"property2": "string"
}
},
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"additional_images": [
"string"
],
"vehicle_color_hex": "strings",
"latitude": 0,
"longitude": 0,
"vehicle_specialized": true,
"expired": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"needs_dealer_review": true,
"dealer_tax_savings": 0,
"dealer_sale_time": "string",
"private_sale_time": "string",
"private_expected_depreciation": 0,
"private_tax_savings": "string",
"state_tax": 0,
"untaxed_amount": 0,
"assigned_dealerships": [
0
],
"expiration_date": "2019-08-24T14:15:22Z",
"is_over_mileage": true,
"equity_lender": "string",
"price_review_reason": 1,
"appraisal_ids": [
0
],
"copy_media_from_offer": "c7e5d2f7-24b5-47db-b380-b598d2624c3e",
"copy_media_from_urls": [
"string"
],
"offer_started_at": "2019-08-24T14:15:22Z",
"load_vhr_data": true,
"lead_path": "string",
"salesperson": "string",
"driveway": "ff343267-de6f-4a69-ac94-d8679fd790ff",
"campaign": "string",
"custom_questions": {},
"custom_notes": "string",
"extras": {},
"expanded_data": {},
"ab_variant": "string",
"host_domain": "string",
"host_url": "string",
"new_vehicle_vin": "string",
"new_vehicle_stock_number": "string",
"new_vehicle_odometer": "string",
"transportation_dropoff_location": "string",
"ignore_expired": true,
"vehicle_match": true,
"push_async": true,
"created": "2019-08-24T14:15:22Z",
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"modified": "2019-08-24T14:15:22Z",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_includes": "string",
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_odor_adjustment": 0,
"vehicle_engine_type": "string",
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"transportation_pickup": true,
"is_consumer_clickthru": true,
"chrome_body_id": -2147483648,
"chrome_style_id": -2147483648,
"chrome_body_style": "string",
"chrome_engine_size": "string",
"negotiated_price": 0,
"dealer_accepted": true,
"trade_desk_accepted": true,
"auto_advanced": true,
"send_to_marketplace": true,
"output_system_path": "string",
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"frame_damage_adjustment": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"did_agree_to_tos": true,
"range_low": 0,
"range_high": 0,
"guaranteed_price": 0,
"boosted_offer_price": 0,
"offer_posted_time": "2019-08-24T14:15:22Z",
"is_dsa_offer": true,
"does_report_events": true,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"add_optional_photos": true,
"expect_transact_months": 0,
"price_review_vote": true,
"vdp": "string",
"cid": "string",
"origin_type": "string",
"origin_ip": "string",
"offer_view_url": "string",
"pricing_country": 1,
"condition_report_path": "string",
"consumer_offer_expiration_period": 0,
"dealer_offer_expiration_period": 0,
"approximate_condition": "excellent",
"single_page_workflow": true,
"vhr_data": {},
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lt": "string",
"visitor_uuid": "string",
"partner_offer_id": "string",
"offer_cert_link": "string",
"offer_return_link": "string",
"appraisal_id": "string",
"sirius_permalink": "string",
"pag_id": "string",
"pag_name": "string",
"pag_logo_url": "string",
"aff_cid": "string",
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"dealer": 0,
"source_system": 0,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"supervisor": 0,
"company": 0,
"partner": 0,
"selected_dealerships": [
0
],
"vehicle_photos": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| archived | string(date-time) | false | read-only | none |
| code | string(uuid) | false | read-only | none |
| offer_short_code | string | false | read-only | none |
| vacs | [OfferVac] | false | none | none |
| media | OfferMedia | false | none | none |
| consumer | Consumer | false | none | none |
| vehicle_price | integer | false | read-only | none |
| vehicle_price_adjustment | integer | false | read-only | none |
| vehicle_offer_price | integer | false | read-only | none |
| vehicle_image | string¦null | false | none | none |
| additional_images | [string] | false | none | none |
| vehicle_color_hex | string¦null | false | none | none |
| latitude | number(decimal)¦null | false | none | none |
| longitude | number(decimal)¦null | false | none | none |
| vehicle_specialized | boolean | false | read-only | none |
| expired | boolean | false | read-only | none |
| uuid | string | false | none | none |
| vdpid | string | false | none | none |
| odid | string | false | none | none |
| needs_dealer_review | boolean | false | read-only | none |
| dealer_tax_savings | integer | false | read-only | none |
| dealer_sale_time | string | false | read-only | none |
| private_sale_time | string | false | read-only | none |
| private_expected_depreciation | number | false | read-only | none |
| private_tax_savings | string | false | read-only | none |
| state_tax | number | false | read-only | none |
| untaxed_amount | integer | false | read-only | none |
| assigned_dealerships | [integer] | false | read-only | none |
| expiration_date | string(date-time) | false | read-only | none |
| is_over_mileage | boolean | false | read-only | none |
| equity_lender | string¦null | false | none | none |
| price_review_reason | integer | false | read-only | Enum Description: 1 - Still Considering 2 - Expected a Higher Price 3 - Not Ready To Sell 4 - Other 5 - Received Better Offer 6 - Selling Privately |
| appraisal_ids | [integer] | false | read-only | none |
| copy_media_from_offer | string(uuid) | false | none | none |
| copy_media_from_urls | [string] | false | none | none |
| offer_started_at | string(date-time) | false | none | none |
| load_vhr_data | boolean | false | none | none |
| lead_path | string¦null | false | none | none |
| salesperson | string | false | none | none |
| driveway | string(uuid) | false | none | none |
| campaign | string | false | none | none |
| custom_questions | object | false | none | none |
| custom_notes | string | false | none | none |
| extras | object¦null | false | none | none |
| expanded_data | object¦null | false | read-only | none |
| ab_variant | string¦null | false | none | none |
| host_domain | string¦null | false | none | none |
| host_url | string¦null | false | none | none |
| new_vehicle_vin | string¦null | false | none | none |
| new_vehicle_stock_number | string¦null | false | none | none |
| new_vehicle_odometer | string¦null | false | none | none |
| transportation_dropoff_location | string¦null | false | none | none |
| ignore_expired | boolean | false | none | none |
| vehicle_match | boolean | false | none | When true, vehicle identifiers associated with the offer will be used to match to an AccuTrade vehicle. This includes vehicle_vin, plate_number/plate_state, chrome_style_id, or vehicle_year/vehicle_make/vehicle_model/vehicle_style. Please note that vehicle_style can always be provided to have more accurate results, for example you can pass vehicle_vin/vehicle_style. There is no guarantee the matched vehicle is accurate or the best available match. Your account must be enabled for this feature. |
| push_async | boolean | false | none | none |
| created | string(date-time) | false | read-only | none |
| vehicle_mismatch | boolean¦null | false | read-only | none |
| vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| vehicle_source_id | string¦null | false | none | none |
| vehicle_vin | string¦null | false | none | none |
| vehicle_year | integer | false | none | none |
| vehicle_make | string | false | none | none |
| vehicle_model | string | false | none | none |
| vehicle_style | string | false | none | none |
| modified | string(date-time) | false | read-only | none |
| origin_offer_code | string | false | none | none |
| type | string | false | read-only | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| pricing_type | string | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price estimate - Estimate ymmt_gp - YMMT Guaranteed Price |
| vin_to_value | boolean¦null | false | none | none |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| source_system_record_id | string¦null | false | none | none |
| key_fobs | integer¦null | false | none | none |
| key_fobs_adjustment | integer | false | read-only | none |
| has_odor | boolean¦null | false | none | none |
| title_status | integer¦null | false | none | Enum Description: 1 - In hand 10 - Payoff 20 - Other |
| is_salvage_title | boolean¦null | false | none | none |
| salvage_title_adjustment | integer | false | read-only | none |
| is_rebuilt_title | boolean¦null | false | none | none |
| is_original_owner | boolean¦null | false | none | none |
| is_liened | boolean¦null | false | none | none |
| is_leased | boolean¦null | false | none | none |
| owed_amount | integer¦null | false | none | none |
| has_accident | boolean¦null | false | none | none |
| vehicle_includes | string¦null | false | none | none |
| vehicle_mileage | integer¦null | false | none | none |
| vehicle_base_miles | integer¦null | false | read-only | none |
| vehicle_trade_price | integer¦null | false | none | none |
| vehicle_market_price | integer¦null | false | none | none |
| vehicle_base_price | integer¦null | false | none | none |
| vehicle_price_was_adjusted | boolean | false | none | none |
| vehicle_odor_adjustment | integer | false | read-only | none |
| vehicle_engine_type | string¦null | false | none | none |
| mileage_adjustment | integer | false | read-only | none |
| postal_code_adjustment | integer | false | read-only | none |
| color_adjustment | integer | false | read-only | none |
| transportation_pickup | boolean¦null | false | none | none |
| is_consumer_clickthru | boolean¦null | false | read-only | none |
| chrome_body_id | integer¦null | false | none | none |
| chrome_style_id | integer¦null | false | none | none |
| chrome_body_style | string¦null | false | none | none |
| chrome_engine_size | string¦null | false | none | none |
| negotiated_price | number(decimal)¦null | false | read-only | none |
| dealer_accepted | boolean | false | read-only | none |
| trade_desk_accepted | boolean | false | read-only | none |
| auto_advanced | boolean | false | read-only | none |
| send_to_marketplace | boolean | false | none | none |
| output_system_path | string | false | read-only | none |
| is_interested_new_vehicle | boolean¦null | false | none | none |
| new_vehicle_year | integer¦null | false | none | none |
| new_vehicle_make | string¦null | false | none | none |
| new_vehicle_model | string¦null | false | none | none |
| new_vehicle_style | string¦null | false | none | none |
| new_vehicle_source_id | string¦null | false | none | none |
| new_vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| new_vehicle_type | string¦null | false | none | Enum Description: new - New used - Used cpo - CPO undecided - Not Sure |
| has_modifications_aftermarket_kit | boolean¦null | false | none | none |
| insurance_payout_amount | number(decimal)¦null | false | none | none |
| insurance_payout_adjustment | integer | false | read-only | none |
| has_external_damage | boolean¦null | false | none | none |
| external_damage_amount | number(decimal)¦null | false | none | none |
| has_frame_damage | boolean¦null | false | none | none |
| frame_damage_adjustment | integer | false | read-only | none |
| front_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| rear_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| liened_type | string¦null | false | none | Enum Description: loan - Loan lease - Lease |
| lease_monthly_payment | number(decimal)¦null | false | none | none |
| lease_number_payments | integer¦null | false | none | none |
| lease_amount_remaining | number(decimal)¦null | false | none | none |
| did_agree_to_tos | boolean | false | none | none |
| range_low | integer¦null | false | read-only | none |
| range_high | integer¦null | false | read-only | none |
| guaranteed_price | integer¦null | false | read-only | none |
| boosted_offer_price | integer¦null | false | read-only | none |
| offer_posted_time | string(date-time)¦null | false | none | none |
| is_dsa_offer | boolean¦null | false | read-only | none |
| does_report_events | boolean¦null | false | read-only | none |
| plate_state | string¦null | false | none | none |
| plate_number | string¦null | false | none | none |
| has_warning_lights | boolean¦null | false | none | none |
| has_warning_lights_4x4 | boolean¦null | false | none | none |
| has_warning_lights_ac | boolean¦null | false | none | none |
| has_warning_lights_abs | boolean¦null | false | none | none |
| has_warning_lights_airbag | boolean¦null | false | none | none |
| has_warning_lights_battery | boolean¦null | false | none | none |
| has_warning_lights_brake | boolean¦null | false | none | none |
| has_warning_lights_engine | boolean¦null | false | none | none |
| has_warning_lights_suspension_fault | boolean¦null | false | none | none |
| has_warning_lights_srs | boolean¦null | false | none | none |
| has_warning_lights_tpms | boolean¦null | false | none | none |
| has_warning_lights_traction_control | boolean¦null | false | none | none |
| has_modifications | boolean¦null | false | none | none |
| has_modifications_exhaust | boolean¦null | false | none | none |
| has_modifications_catalytic_converter | boolean¦null | false | none | none |
| has_modifications_performance | boolean¦null | false | none | none |
| has_modifications_stereo | boolean¦null | false | none | none |
| has_modifications_spoiler | boolean¦null | false | none | none |
| has_modifications_suspension_lowered | boolean¦null | false | none | none |
| has_modifications_suspension_lifted | boolean¦null | false | none | none |
| has_modifications_sunroof_moonroof | boolean¦null | false | none | none |
| has_modifications_wheel | boolean¦null | false | none | none |
| has_aftermarket_tint | boolean¦null | false | none | none |
| has_mechanical_issues | boolean¦null | false | none | none |
| has_mechanical_sunroof_moonroof | boolean¦null | false | none | none |
| has_mechanical_suspension | boolean¦null | false | none | none |
| has_mechanical_brakes | boolean¦null | false | none | none |
| has_mechanical_engine | boolean¦null | false | none | none |
| has_mechanical_exhaust | boolean¦null | false | none | none |
| has_mechanical_transmission | boolean¦null | false | none | none |
| has_mechanical_ac | boolean¦null | false | none | none |
| has_mechanical_oil_leak | boolean¦null | false | none | none |
| has_mechanical_head_gasket | boolean¦null | false | none | none |
| has_mechanical_catalytic_converter | boolean¦null | false | none | none |
| has_mechanical_other | boolean¦null | false | none | none |
| mechanical_other_note | string | false | none | none |
| has_other_issues | boolean¦null | false | none | none |
| has_flood_damage | boolean¦null | false | none | none |
| has_fire_damage | boolean¦null | false | none | none |
| has_hail_damage | boolean¦null | false | none | none |
| was_stolen | boolean¦null | false | none | none |
| has_unnamed_issue | boolean¦null | false | none | none |
| other_issues_repair_cost | number(decimal)¦null | false | none | none |
| has_significant_issues | boolean¦null | false | none | none |
| damage_panels | object¦null | false | none | none |
| add_optional_photos | boolean¦null | false | none | none |
| expect_transact_months | integer¦null | false | none | Enum Description: 0 - Ready to sell now 2 - 2 - 6 months 100 - Curious |
| price_review_vote | boolean¦null | false | read-only | none |
| vdp | string¦null | false | none | none |
| cid | string¦null | false | none | none |
| origin_type | string¦null | false | none | none |
| origin_ip | string¦null | false | read-only | none |
| offer_view_url | string | false | none | none |
| pricing_country | integer | false | read-only | Enum Description: 1 - United States 2 - Canada |
| condition_report_path | string¦null | false | read-only | none |
| consumer_offer_expiration_period | integer | false | read-only | none |
| dealer_offer_expiration_period | integer | false | read-only | none |
| approximate_condition | string¦null | false | none | Enum Description: excellent - Excellent good - Good fair - Fair poor - Poor |
| single_page_workflow | boolean | false | none | none |
| vhr_data | object¦null | false | read-only | none |
| carfax_accident_reported | boolean¦null | false | read-only | none |
| carfax_num_previous_owners | integer¦null | false | read-only | none |
| carfax_expected_mileage | integer¦null | false | read-only | none |
| carfax_last_reported_mileage | integer¦null | false | read-only | none |
| carfax_has_salvaged_title_issue | boolean¦null | false | read-only | none |
| carfax_has_bad_vhr | boolean¦null | false | none | none |
| carfax_bad_vhr_adjustment | integer | false | read-only | none |
| lt | string¦null | false | none | none |
| visitor_uuid | string¦null | false | none | none |
| partner_offer_id | string¦null | false | none | none |
| offer_cert_link | string¦null | false | none | none |
| offer_return_link | string¦null | false | none | none |
| appraisal_id | string¦null | false | read-only | none |
| sirius_permalink | string¦null | false | read-only | none |
| pag_id | string¦null | false | none | none |
| pag_name | string¦null | false | none | none |
| pag_logo_url | string¦null | false | none | none |
| aff_cid | string¦null | false | none | none |
| lead_source | string¦null | false | none | Enum Description: leadstart_api - API leadstart_widget - Dealer Widget leadstart_banner - Typeahead Banner leadstart_drawer - Typeahead Drawer leadstart_hero - Typeahead Hero leadstart_heroba - Typeahead Hero Banner leadstart_hdless - Typeahead Headless |
| is_equity | boolean¦null | false | none | none |
| step_completion | integer¦null | false | none | none |
| is_testing | boolean | false | none | none |
| dealer | integer¦null | false | read-only | none |
| source_system | integer¦null | false | read-only | none |
| vehicle_color | integer¦null | false | none | none |
| vehicle_interior_color | integer¦null | false | none | none |
| supervisor | integer¦null | false | none | none |
| company | integer | false | read-only | none |
| partner | integer¦null | false | read-only | none |
| selected_dealerships | [integer] | false | read-only | none |
| vehicle_photos | [integer] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| price_review_reason | 1 |
| price_review_reason | 2 |
| price_review_reason | 3 |
| price_review_reason | 4 |
| price_review_reason | 5 |
| price_review_reason | 6 |
| vehicle_source | 1 |
| vehicle_source | 2 |
| vehicle_source | 3 |
| type | consumer |
| type | dealer |
| type | algol |
| pricing_type | ranged |
| pricing_type | gp |
| pricing_type | estimate |
| pricing_type | ymmt_gp |
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| title_status | 1 |
| title_status | 10 |
| title_status | 20 |
| new_vehicle_source | 1 |
| new_vehicle_source | 2 |
| new_vehicle_source | 3 |
| new_vehicle_type | new |
| new_vehicle_type | used |
| new_vehicle_type | cpo |
| new_vehicle_type | undecided |
| front_tire_age | poor |
| front_tire_age | good |
| front_tire_age | excellent |
| rear_tire_age | poor |
| rear_tire_age | good |
| rear_tire_age | excellent |
| liened_type | loan |
| liened_type | lease |
| expect_transact_months | 0 |
| expect_transact_months | 2 |
| expect_transact_months | 100 |
| pricing_country | 1 |
| pricing_country | 2 |
| approximate_condition | excellent |
| approximate_condition | good |
| approximate_condition | fair |
| approximate_condition | poor |
| lead_source | leadstart_api |
| lead_source | leadstart_widget |
| lead_source | leadstart_banner |
| lead_source | leadstart_drawer |
| lead_source | leadstart_hero |
| lead_source | leadstart_heroba |
| lead_source | leadstart_hdless |
PricingAdjustmentsOriginalOwner
{
"yes": 0,
"no": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| yes | integer | true | none | none |
| no | integer | true | none | none |
PricingAdjustmentsTires
{
"excellent": 0,
"good": 0,
"poor": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| excellent | integer | true | none | none |
| good | integer | true | none | none |
| poor | integer | true | none | none |
PricingAdjustments
{
"vehicle_odor_adjustment": 0,
"original_owner_adjustment": {
"yes": 0,
"no": 0
},
"carfax_bad_vhr_adjustment": 0,
"frame_damage_adjustment": 0,
"tire_adjustment": {
"excellent": 0,
"good": 0,
"poor": 0
},
"salvage_title_adjustment": 0,
"fire_damage_adjustment": 0,
"flood_damage_adjustment": 0,
"stolen_adjustment": 0,
"mechanical_suspension_adjustment": 0,
"mechanical_sunroof_moonroof_adjustment": 0,
"mechanical_catalytic_converter_adjustment": 0,
"mechanical_engine_adjustment": 0,
"mechanical_brakes_adjustment": 0,
"mechanical_exhaust_adjustment": 0,
"mechanical_transmission_adjustment": 0,
"mechanical_oil_leak_adjustment": 0,
"mechanical_head_gasket_adjustment": 0,
"warning_lights_abs_adjustment": 0,
"warning_lights_brake_adjustment": 0,
"warning_lights_engine_adjustment": 0,
"warning_lights_suspension_fault_adjustment": 0,
"warning_lights_airbag_adjustment": 0,
"warning_lights_battery_adjustment": 0,
"warning_lights_tpms_adjustment": 0,
"warning_lights_traction_control_adjustment": 0,
"modifications_suspension_lowered_adjustment": 0,
"modifications_suspension_raised_adjustment": 0,
"modifications_wheel_adjustment": 0,
"modifications_exhaust_adjustment": 0,
"modifications_aftermarket_tint_adjustment": 0,
"modifications_stereo_adjustment": 0,
"modifications_performance_adjustment": 0,
"modifications_sunroof_moonroof_adjustment": 0,
"modifications_spoiler_adjustment": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| vehicle_odor_adjustment | integer | true | none | none |
| original_owner_adjustment | PricingAdjustmentsOriginalOwner | true | none | none |
| carfax_bad_vhr_adjustment | integer | true | none | none |
| frame_damage_adjustment | integer | true | none | none |
| tire_adjustment | PricingAdjustmentsTires | true | none | none |
| salvage_title_adjustment | integer | true | none | none |
| fire_damage_adjustment | integer | true | none | none |
| flood_damage_adjustment | integer | true | none | none |
| stolen_adjustment | integer | true | none | none |
| mechanical_suspension_adjustment | integer | true | none | none |
| mechanical_sunroof_moonroof_adjustment | integer | true | none | none |
| mechanical_catalytic_converter_adjustment | integer | true | none | none |
| mechanical_engine_adjustment | integer | true | none | none |
| mechanical_brakes_adjustment | integer | true | none | none |
| mechanical_exhaust_adjustment | integer | true | none | none |
| mechanical_transmission_adjustment | integer | true | none | none |
| mechanical_oil_leak_adjustment | integer | true | none | none |
| mechanical_head_gasket_adjustment | integer | true | none | none |
| warning_lights_abs_adjustment | integer | true | none | none |
| warning_lights_brake_adjustment | integer | true | none | none |
| warning_lights_engine_adjustment | integer | true | none | none |
| warning_lights_suspension_fault_adjustment | integer | true | none | none |
| warning_lights_airbag_adjustment | integer | true | none | none |
| warning_lights_battery_adjustment | integer | true | none | none |
| warning_lights_tpms_adjustment | integer | true | none | none |
| warning_lights_traction_control_adjustment | integer | true | none | none |
| modifications_suspension_lowered_adjustment | integer | true | none | none |
| modifications_suspension_raised_adjustment | integer | true | none | none |
| modifications_wheel_adjustment | integer | true | none | none |
| modifications_exhaust_adjustment | integer | true | none | none |
| modifications_aftermarket_tint_adjustment | integer | true | none | none |
| modifications_stereo_adjustment | integer | true | none | none |
| modifications_performance_adjustment | integer | true | none | none |
| modifications_sunroof_moonroof_adjustment | integer | true | none | none |
| modifications_spoiler_adjustment | integer | true | none | none |
PostalCodeValidation
{
"postal_code": "string",
"make": "string",
"new_vehicle_make": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| postal_code | string | false | none | none |
| make | string | false | none | none |
| new_vehicle_make | string | false | none | none |
OfferPricingCalculate
{
"id": 0,
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"vehicle_match": true,
"vehicle_year": 1900,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"pricing_boost_to_market": true,
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"approximate_condition": "excellent",
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"vehicle_photos": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| code | string(uuid)¦null | false | none | Offer code to use as starting point for pricing |
| offer_short_code | string | false | read-only | none |
| vacs | [OfferVac] | false | none | none |
| consumer | Consumer | false | none | none |
| vehicle_price | integer | false | read-only | none |
| vehicle_price_adjustment | integer | false | read-only | none |
| vehicle_offer_price | integer | false | read-only | none |
| vehicle_image | string¦null | false | none | none |
| vehicle_color_hex | string¦null | false | none | none |
| vehicle_specialized | boolean | false | read-only | none |
| uuid | string | false | none | none |
| vdpid | string | false | none | none |
| odid | string | false | none | none |
| equity_lender | string¦null | false | none | none |
| vehicle_match | boolean | false | none | When true, vehicle identifiers associated with the offer will be used to match to an AccuTrade vehicle. This includes vehicle_vin, plate_number/plate_state, chrome_style_id, or vehicle_year/vehicle_make/vehicle_model/vehicle_style. Please note that vehicle_style can always be provided to have more accurate results, for example you can pass vehicle_vin/vehicle_style. There is no guarantee the matched vehicle is accurate or the best available match. Your account must be enabled for this feature. |
| vehicle_year | integer | false | none | none |
| vehicle_make | string | false | none | none |
| vehicle_model | string | false | none | none |
| vehicle_style | string | false | none | none |
| pricing_boost_to_market | boolean¦null | false | none | If supported, pricing result will be at market level instead of trade level with indication. |
| vehicle_mismatch | boolean¦null | false | read-only | none |
| vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| vehicle_source_id | string¦null | false | none | none |
| vehicle_vin | string¦null | false | none | none |
| origin_offer_code | string | false | none | none |
| type | string | false | read-only | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| pricing_type | string | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price estimate - Estimate ymmt_gp - YMMT Guaranteed Price |
| vin_to_value | boolean¦null | false | none | none |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| source_system_record_id | string¦null | false | none | none |
| key_fobs | integer¦null | false | none | none |
| key_fobs_adjustment | integer | false | read-only | none |
| has_odor | boolean¦null | false | none | none |
| title_status | integer¦null | false | none | Enum Description: 1 - In hand 10 - Payoff 20 - Other |
| is_salvage_title | boolean¦null | false | none | none |
| salvage_title_adjustment | integer | false | read-only | none |
| is_rebuilt_title | boolean¦null | false | none | none |
| is_original_owner | boolean¦null | false | none | none |
| is_liened | boolean¦null | false | none | none |
| is_leased | boolean¦null | false | none | none |
| owed_amount | integer¦null | false | none | none |
| has_accident | boolean¦null | false | none | none |
| vehicle_mileage | integer¦null | false | none | none |
| vehicle_base_miles | integer¦null | false | read-only | none |
| vehicle_trade_price | integer¦null | false | none | none |
| vehicle_market_price | integer¦null | false | none | none |
| vehicle_base_price | integer¦null | false | none | none |
| vehicle_price_was_adjusted | boolean | false | none | none |
| vehicle_engine_type | string¦null | false | none | none |
| transportation_pickup | boolean¦null | false | none | none |
| is_interested_new_vehicle | boolean¦null | false | none | none |
| new_vehicle_year | integer¦null | false | none | none |
| new_vehicle_make | string¦null | false | none | none |
| new_vehicle_model | string¦null | false | none | none |
| new_vehicle_style | string¦null | false | none | none |
| new_vehicle_source_id | string¦null | false | none | none |
| new_vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| new_vehicle_type | string¦null | false | none | Enum Description: new - New used - Used cpo - CPO undecided - Not Sure |
| has_modifications_aftermarket_kit | boolean¦null | false | none | none |
| insurance_payout_amount | number(decimal)¦null | false | none | none |
| has_external_damage | boolean¦null | false | none | none |
| external_damage_amount | number(decimal)¦null | false | none | none |
| has_frame_damage | boolean¦null | false | none | none |
| front_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| rear_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| liened_type | string¦null | false | none | Enum Description: loan - Loan lease - Lease |
| lease_monthly_payment | number(decimal)¦null | false | none | none |
| lease_number_payments | integer¦null | false | none | none |
| lease_amount_remaining | number(decimal)¦null | false | none | none |
| plate_state | string¦null | false | none | none |
| plate_number | string¦null | false | none | none |
| has_warning_lights | boolean¦null | false | none | none |
| has_warning_lights_4x4 | boolean¦null | false | none | none |
| has_warning_lights_ac | boolean¦null | false | none | none |
| has_warning_lights_abs | boolean¦null | false | none | none |
| has_warning_lights_airbag | boolean¦null | false | none | none |
| has_warning_lights_battery | boolean¦null | false | none | none |
| has_warning_lights_brake | boolean¦null | false | none | none |
| has_warning_lights_engine | boolean¦null | false | none | none |
| has_warning_lights_suspension_fault | boolean¦null | false | none | none |
| has_warning_lights_srs | boolean¦null | false | none | none |
| has_warning_lights_tpms | boolean¦null | false | none | none |
| has_warning_lights_traction_control | boolean¦null | false | none | none |
| has_modifications | boolean¦null | false | none | none |
| has_modifications_exhaust | boolean¦null | false | none | none |
| has_modifications_catalytic_converter | boolean¦null | false | none | none |
| has_modifications_performance | boolean¦null | false | none | none |
| has_modifications_stereo | boolean¦null | false | none | none |
| has_modifications_spoiler | boolean¦null | false | none | none |
| has_modifications_suspension_lowered | boolean¦null | false | none | none |
| has_modifications_suspension_lifted | boolean¦null | false | none | none |
| has_modifications_sunroof_moonroof | boolean¦null | false | none | none |
| has_modifications_wheel | boolean¦null | false | none | none |
| has_aftermarket_tint | boolean¦null | false | none | none |
| has_mechanical_issues | boolean¦null | false | none | none |
| has_mechanical_sunroof_moonroof | boolean¦null | false | none | none |
| has_mechanical_suspension | boolean¦null | false | none | none |
| has_mechanical_brakes | boolean¦null | false | none | none |
| has_mechanical_engine | boolean¦null | false | none | none |
| has_mechanical_exhaust | boolean¦null | false | none | none |
| has_mechanical_transmission | boolean¦null | false | none | none |
| has_mechanical_ac | boolean¦null | false | none | none |
| has_mechanical_oil_leak | boolean¦null | false | none | none |
| has_mechanical_head_gasket | boolean¦null | false | none | none |
| has_mechanical_catalytic_converter | boolean¦null | false | none | none |
| has_mechanical_other | boolean¦null | false | none | none |
| mechanical_other_note | string | false | none | none |
| has_other_issues | boolean¦null | false | none | none |
| has_flood_damage | boolean¦null | false | none | none |
| has_fire_damage | boolean¦null | false | none | none |
| has_hail_damage | boolean¦null | false | none | none |
| was_stolen | boolean¦null | false | none | none |
| has_unnamed_issue | boolean¦null | false | none | none |
| other_issues_repair_cost | number(decimal)¦null | false | none | none |
| has_significant_issues | boolean¦null | false | none | none |
| damage_panels | object¦null | false | none | none |
| approximate_condition | string¦null | false | none | Enum Description: excellent - Excellent good - Good fair - Fair poor - Poor |
| carfax_accident_reported | boolean¦null | false | read-only | none |
| carfax_num_previous_owners | integer¦null | false | read-only | none |
| carfax_expected_mileage | integer¦null | false | read-only | none |
| carfax_last_reported_mileage | integer¦null | false | read-only | none |
| carfax_has_salvaged_title_issue | boolean¦null | false | read-only | none |
| carfax_has_bad_vhr | boolean¦null | false | none | none |
| carfax_bad_vhr_adjustment | integer | false | read-only | none |
| lead_source | string¦null | false | none | Enum Description: leadstart_api - API leadstart_widget - Dealer Widget leadstart_banner - Typeahead Banner leadstart_drawer - Typeahead Drawer leadstart_hero - Typeahead Hero leadstart_heroba - Typeahead Hero Banner leadstart_hdless - Typeahead Headless |
| is_equity | boolean¦null | false | none | none |
| step_completion | integer¦null | false | none | none |
| is_testing | boolean | false | none | none |
| vehicle_color | integer¦null | false | none | none |
| vehicle_interior_color | integer¦null | false | none | none |
| vehicle_photos | [integer] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| vehicle_source | 1 |
| vehicle_source | 2 |
| vehicle_source | 3 |
| type | consumer |
| type | dealer |
| type | algol |
| pricing_type | ranged |
| pricing_type | gp |
| pricing_type | estimate |
| pricing_type | ymmt_gp |
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| title_status | 1 |
| title_status | 10 |
| title_status | 20 |
| new_vehicle_source | 1 |
| new_vehicle_source | 2 |
| new_vehicle_source | 3 |
| new_vehicle_type | new |
| new_vehicle_type | used |
| new_vehicle_type | cpo |
| new_vehicle_type | undecided |
| front_tire_age | poor |
| front_tire_age | good |
| front_tire_age | excellent |
| rear_tire_age | poor |
| rear_tire_age | good |
| rear_tire_age | excellent |
| liened_type | loan |
| liened_type | lease |
| approximate_condition | excellent |
| approximate_condition | good |
| approximate_condition | fair |
| approximate_condition | poor |
| lead_source | leadstart_api |
| lead_source | leadstart_widget |
| lead_source | leadstart_banner |
| lead_source | leadstart_drawer |
| lead_source | leadstart_hero |
| lead_source | leadstart_heroba |
| lead_source | leadstart_hdless |
OfferPricingResult
{
"value": "string",
"range": "string",
"pricing_boost_to_market": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string | false | read-only | Current vehicle single point price |
| range | string | false | read-only | Current vehicle ranged price |
| pricing_boost_to_market | boolean | false | none | none |
OfferPricingTrendCalculate
{
"id": 0,
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"consumer": {
"id": 0,
"first_name": "string",
"last_name": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"email": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"member_identifier": "string",
"sms_last_sent_at": "2019-08-24T14:15:22Z",
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"vehicle_price": 0,
"vehicle_price_adjustment": 0,
"vehicle_offer_price": 0,
"vehicle_image": "string",
"vehicle_color_hex": "strings",
"vehicle_specialized": true,
"uuid": "string",
"vdpid": "string",
"odid": "string",
"equity_lender": "string",
"vehicle_match": true,
"vehicle_year": 1900,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"pricing_boost_to_market": true,
"trend_start_date": "2019-08-24",
"trend_stop_date": "2019-08-24",
"forecasted_dates": [
"2019-08-24"
],
"vehicle_mismatch": true,
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_vin": "string",
"origin_offer_code": "string",
"type": "consumer",
"pricing_type": "ranged",
"vin_to_value": true,
"status": "draft",
"source_system_record_id": "string",
"key_fobs": -2147483648,
"key_fobs_adjustment": 0,
"has_odor": true,
"title_status": 1,
"is_salvage_title": true,
"salvage_title_adjustment": 0,
"is_rebuilt_title": true,
"is_original_owner": true,
"is_liened": true,
"is_leased": true,
"owed_amount": -2147483648,
"has_accident": true,
"vehicle_mileage": -2147483648,
"vehicle_base_miles": 0,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price_was_adjusted": true,
"vehicle_engine_type": "string",
"transportation_pickup": true,
"is_interested_new_vehicle": true,
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source_id": "string",
"new_vehicle_source": 1,
"new_vehicle_type": "new",
"has_modifications_aftermarket_kit": true,
"insurance_payout_amount": 0,
"has_external_damage": true,
"external_damage_amount": 0,
"has_frame_damage": true,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"liened_type": "loan",
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"plate_state": "st",
"plate_number": "string",
"has_warning_lights": true,
"has_warning_lights_4x4": true,
"has_warning_lights_ac": true,
"has_warning_lights_abs": true,
"has_warning_lights_airbag": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_srs": true,
"has_warning_lights_tpms": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_catalytic_converter": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_suspension_lowered": true,
"has_modifications_suspension_lifted": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_mechanical_issues": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_brakes": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_transmission": true,
"has_mechanical_ac": true,
"has_mechanical_oil_leak": true,
"has_mechanical_head_gasket": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_other_issues": true,
"has_flood_damage": true,
"has_fire_damage": true,
"has_hail_damage": true,
"was_stolen": true,
"has_unnamed_issue": true,
"other_issues_repair_cost": 0,
"has_significant_issues": true,
"damage_panels": {},
"approximate_condition": "excellent",
"carfax_accident_reported": true,
"carfax_num_previous_owners": 0,
"carfax_expected_mileage": 0,
"carfax_last_reported_mileage": 0,
"carfax_has_salvaged_title_issue": true,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": 0,
"lead_source": "leadstart_api",
"is_equity": true,
"step_completion": -32768,
"is_testing": true,
"vehicle_color": 0,
"vehicle_interior_color": 0,
"vehicle_photos": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| code | string(uuid)¦null | false | none | Offer code to use as starting point for pricing |
| offer_short_code | string | false | read-only | none |
| vacs | [OfferVac] | false | none | none |
| consumer | Consumer | false | none | none |
| vehicle_price | integer | false | read-only | none |
| vehicle_price_adjustment | integer | false | read-only | none |
| vehicle_offer_price | integer | false | read-only | none |
| vehicle_image | string¦null | false | none | none |
| vehicle_color_hex | string¦null | false | none | none |
| vehicle_specialized | boolean | false | read-only | none |
| uuid | string | false | none | none |
| vdpid | string | false | none | none |
| odid | string | false | none | none |
| equity_lender | string¦null | false | none | none |
| vehicle_match | boolean | false | none | When true, vehicle identifiers associated with the offer will be used to match to an AccuTrade vehicle. This includes vehicle_vin, plate_number/plate_state, chrome_style_id, or vehicle_year/vehicle_make/vehicle_model/vehicle_style. Please note that vehicle_style can always be provided to have more accurate results, for example you can pass vehicle_vin/vehicle_style. There is no guarantee the matched vehicle is accurate or the best available match. Your account must be enabled for this feature. |
| vehicle_year | integer | false | none | none |
| vehicle_make | string | false | none | none |
| vehicle_model | string | false | none | none |
| vehicle_style | string | false | none | none |
| pricing_boost_to_market | boolean¦null | false | none | If supported, pricing result will be at market level instead of trade level with indication. |
| trend_start_date | string(date) | true | none | none |
| trend_stop_date | string(date) | true | none | none |
| forecasted_dates | [string]¦null | false | none | none |
| vehicle_mismatch | boolean¦null | false | read-only | none |
| vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| vehicle_source_id | string¦null | false | none | none |
| vehicle_vin | string¦null | false | none | none |
| origin_offer_code | string | false | none | none |
| type | string | false | read-only | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| pricing_type | string | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price estimate - Estimate ymmt_gp - YMMT Guaranteed Price |
| vin_to_value | boolean¦null | false | none | none |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| source_system_record_id | string¦null | false | none | none |
| key_fobs | integer¦null | false | none | none |
| key_fobs_adjustment | integer | false | read-only | none |
| has_odor | boolean¦null | false | none | none |
| title_status | integer¦null | false | none | Enum Description: 1 - In hand 10 - Payoff 20 - Other |
| is_salvage_title | boolean¦null | false | none | none |
| salvage_title_adjustment | integer | false | read-only | none |
| is_rebuilt_title | boolean¦null | false | none | none |
| is_original_owner | boolean¦null | false | none | none |
| is_liened | boolean¦null | false | none | none |
| is_leased | boolean¦null | false | none | none |
| owed_amount | integer¦null | false | none | none |
| has_accident | boolean¦null | false | none | none |
| vehicle_mileage | integer¦null | false | none | none |
| vehicle_base_miles | integer¦null | false | read-only | none |
| vehicle_trade_price | integer¦null | false | none | none |
| vehicle_market_price | integer¦null | false | none | none |
| vehicle_base_price | integer¦null | false | none | none |
| vehicle_price_was_adjusted | boolean | false | none | none |
| vehicle_engine_type | string¦null | false | none | none |
| transportation_pickup | boolean¦null | false | none | none |
| is_interested_new_vehicle | boolean¦null | false | none | none |
| new_vehicle_year | integer¦null | false | none | none |
| new_vehicle_make | string¦null | false | none | none |
| new_vehicle_model | string¦null | false | none | none |
| new_vehicle_style | string¦null | false | none | none |
| new_vehicle_source_id | string¦null | false | none | none |
| new_vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| new_vehicle_type | string¦null | false | none | Enum Description: new - New used - Used cpo - CPO undecided - Not Sure |
| has_modifications_aftermarket_kit | boolean¦null | false | none | none |
| insurance_payout_amount | number(decimal)¦null | false | none | none |
| has_external_damage | boolean¦null | false | none | none |
| external_damage_amount | number(decimal)¦null | false | none | none |
| has_frame_damage | boolean¦null | false | none | none |
| front_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| rear_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| liened_type | string¦null | false | none | Enum Description: loan - Loan lease - Lease |
| lease_monthly_payment | number(decimal)¦null | false | none | none |
| lease_number_payments | integer¦null | false | none | none |
| lease_amount_remaining | number(decimal)¦null | false | none | none |
| plate_state | string¦null | false | none | none |
| plate_number | string¦null | false | none | none |
| has_warning_lights | boolean¦null | false | none | none |
| has_warning_lights_4x4 | boolean¦null | false | none | none |
| has_warning_lights_ac | boolean¦null | false | none | none |
| has_warning_lights_abs | boolean¦null | false | none | none |
| has_warning_lights_airbag | boolean¦null | false | none | none |
| has_warning_lights_battery | boolean¦null | false | none | none |
| has_warning_lights_brake | boolean¦null | false | none | none |
| has_warning_lights_engine | boolean¦null | false | none | none |
| has_warning_lights_suspension_fault | boolean¦null | false | none | none |
| has_warning_lights_srs | boolean¦null | false | none | none |
| has_warning_lights_tpms | boolean¦null | false | none | none |
| has_warning_lights_traction_control | boolean¦null | false | none | none |
| has_modifications | boolean¦null | false | none | none |
| has_modifications_exhaust | boolean¦null | false | none | none |
| has_modifications_catalytic_converter | boolean¦null | false | none | none |
| has_modifications_performance | boolean¦null | false | none | none |
| has_modifications_stereo | boolean¦null | false | none | none |
| has_modifications_spoiler | boolean¦null | false | none | none |
| has_modifications_suspension_lowered | boolean¦null | false | none | none |
| has_modifications_suspension_lifted | boolean¦null | false | none | none |
| has_modifications_sunroof_moonroof | boolean¦null | false | none | none |
| has_modifications_wheel | boolean¦null | false | none | none |
| has_aftermarket_tint | boolean¦null | false | none | none |
| has_mechanical_issues | boolean¦null | false | none | none |
| has_mechanical_sunroof_moonroof | boolean¦null | false | none | none |
| has_mechanical_suspension | boolean¦null | false | none | none |
| has_mechanical_brakes | boolean¦null | false | none | none |
| has_mechanical_engine | boolean¦null | false | none | none |
| has_mechanical_exhaust | boolean¦null | false | none | none |
| has_mechanical_transmission | boolean¦null | false | none | none |
| has_mechanical_ac | boolean¦null | false | none | none |
| has_mechanical_oil_leak | boolean¦null | false | none | none |
| has_mechanical_head_gasket | boolean¦null | false | none | none |
| has_mechanical_catalytic_converter | boolean¦null | false | none | none |
| has_mechanical_other | boolean¦null | false | none | none |
| mechanical_other_note | string | false | none | none |
| has_other_issues | boolean¦null | false | none | none |
| has_flood_damage | boolean¦null | false | none | none |
| has_fire_damage | boolean¦null | false | none | none |
| has_hail_damage | boolean¦null | false | none | none |
| was_stolen | boolean¦null | false | none | none |
| has_unnamed_issue | boolean¦null | false | none | none |
| other_issues_repair_cost | number(decimal)¦null | false | none | none |
| has_significant_issues | boolean¦null | false | none | none |
| damage_panels | object¦null | false | none | none |
| approximate_condition | string¦null | false | none | Enum Description: excellent - Excellent good - Good fair - Fair poor - Poor |
| carfax_accident_reported | boolean¦null | false | read-only | none |
| carfax_num_previous_owners | integer¦null | false | read-only | none |
| carfax_expected_mileage | integer¦null | false | read-only | none |
| carfax_last_reported_mileage | integer¦null | false | read-only | none |
| carfax_has_salvaged_title_issue | boolean¦null | false | read-only | none |
| carfax_has_bad_vhr | boolean¦null | false | none | none |
| carfax_bad_vhr_adjustment | integer | false | read-only | none |
| lead_source | string¦null | false | none | Enum Description: leadstart_api - API leadstart_widget - Dealer Widget leadstart_banner - Typeahead Banner leadstart_drawer - Typeahead Drawer leadstart_hero - Typeahead Hero leadstart_heroba - Typeahead Hero Banner leadstart_hdless - Typeahead Headless |
| is_equity | boolean¦null | false | none | none |
| step_completion | integer¦null | false | none | none |
| is_testing | boolean | false | none | none |
| vehicle_color | integer¦null | false | none | none |
| vehicle_interior_color | integer¦null | false | none | none |
| vehicle_photos | [integer] | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| vehicle_source | 1 |
| vehicle_source | 2 |
| vehicle_source | 3 |
| type | consumer |
| type | dealer |
| type | algol |
| pricing_type | ranged |
| pricing_type | gp |
| pricing_type | estimate |
| pricing_type | ymmt_gp |
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| title_status | 1 |
| title_status | 10 |
| title_status | 20 |
| new_vehicle_source | 1 |
| new_vehicle_source | 2 |
| new_vehicle_source | 3 |
| new_vehicle_type | new |
| new_vehicle_type | used |
| new_vehicle_type | cpo |
| new_vehicle_type | undecided |
| front_tire_age | poor |
| front_tire_age | good |
| front_tire_age | excellent |
| rear_tire_age | poor |
| rear_tire_age | good |
| rear_tire_age | excellent |
| liened_type | loan |
| liened_type | lease |
| approximate_condition | excellent |
| approximate_condition | good |
| approximate_condition | fair |
| approximate_condition | poor |
| lead_source | leadstart_api |
| lead_source | leadstart_widget |
| lead_source | leadstart_banner |
| lead_source | leadstart_drawer |
| lead_source | leadstart_hero |
| lead_source | leadstart_heroba |
| lead_source | leadstart_hdless |
OfferPricingPoint
{
"date": "2019-08-24",
"ico": 0,
"ico_from_offer": true,
"retail": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date) | true | none | none |
| ico | integer¦null | true | none | none |
| ico_from_offer | boolean | true | none | none |
| retail | integer¦null | true | none | none |
OfferGuaranteedPrice
{
"value": "string",
"original_range": "string",
"range": "string",
"completion": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | string | false | read-only | Current vehicle single point price |
| original_range | string | false | read-only | If range is boosted this will contain the original ranged price. |
| range | string | false | read-only | Current vehicle ranged price |
| completion | string | false | read-only | Unused |
OfferPricingTrend
{
"pricing_trend": [
{
"date": "2019-08-24",
"ico": 0,
"ico_from_offer": true,
"retail": 0
}
],
"pricing": {
"value": "string",
"original_range": "string",
"range": "string",
"completion": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pricing_trend | [OfferPricingPoint] | true | none | none |
| pricing | OfferGuaranteedPrice | true | none | none |
OfferComplete
{
"push_async": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| push_async | boolean | false | none | none |
ConsumerSimple
{
"first_name": "string",
"last_name": "string",
"email": "string",
"cell_phone": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"member_identifier": "string",
"best_time_to_contact": "0",
"preferred_contact_method": "phone",
"phone_verified": true,
"bypass_validation": false,
"sms_last_sent_at": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| first_name | string¦null | false | none | none |
| last_name | string¦null | false | none | none |
| string¦null | false | none | none | |
| cell_phone | string¦null | false | none | none |
| city | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postal_code | string¦null | false | none | none |
| member_identifier | string¦null | false | none | none |
| best_time_to_contact | string¦null | false | none | Enum Description: 0 - Unknown 1 - Morning 2 - Afternoon 3 - Evening |
| preferred_contact_method | string¦null | false | none | Enum Description: phone - Phone email - Email |
| phone_verified | boolean¦null | false | none | none |
| bypass_validation | boolean | false | none | none |
| sms_last_sent_at | string(date-time)¦null | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| best_time_to_contact | 0 |
| best_time_to_contact | 1 |
| best_time_to_contact | 2 |
| best_time_to_contact | 3 |
| preferred_contact_method | phone |
| preferred_contact_method |
VerificationCodeCheck
{
"code": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | string | true | none | none |
OfferConsumerMaskedData
{
"dealer_id": 0,
"cell_phone": "string",
"email": "user@example.com"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealer_id | integer | true | none | none |
| cell_phone | string¦null | false | none | none |
| string(email)¦null | false | none | none |
VerificationCodeSend
{
"mode": "sms"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mode | string | true | none | Enum Description: sms - sms call - call |
Enumerated Values
| Property | Value |
|---|---|
| mode | sms |
| mode | call |
OfferContactDealerMessage
{
"dealer_id": [
0
],
"message": "string",
"request_appointment": true,
"desire_browse_lot": true,
"desire_test_drive": true,
"desire_consultation": true,
"desire_financing": true,
"desire_sell_only": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealer_id | [integer] | true | none | none |
| message | string¦null | false | none | none |
| request_appointment | boolean¦null | false | none | none |
| desire_browse_lot | boolean¦null | false | none | none |
| desire_test_drive | boolean¦null | false | none | none |
| desire_consultation | boolean¦null | false | none | none |
| desire_financing | boolean¦null | false | none | none |
| desire_sell_only | boolean¦null | false | none | none |
OfferLocalMarketResult
{
"vin": "string",
"sale_type": "string",
"seller_type": "string",
"stock_number": "string",
"year": 0,
"make": "string",
"model": "string",
"style": "string",
"location": [
0
],
"distance": 0,
"status": "string",
"country": 0,
"mileage": 0,
"price": 0,
"exterior_color": "string",
"thumbnail": "string",
"vdp_link": "string",
"dom": 0,
"last_seen_date": "2019-08-24T14:15:22Z",
"most_comparable": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| vin | string | true | none | none |
| sale_type | string | true | none | none |
| seller_type | string | true | none | none |
| stock_number | string | true | none | none |
| year | integer | true | none | none |
| make | string | true | none | none |
| model | string | true | none | none |
| style | string | true | none | none |
| location | [number] | true | none | none |
| distance | number | true | none | none |
| status | string | true | none | none |
| country | integer | true | none | none |
| mileage | integer | true | none | none |
| price | integer | true | none | none |
| exterior_color | string | true | none | none |
| thumbnail | string | true | none | none |
| vdp_link | string | true | none | none |
| dom | integer | true | none | none |
| last_seen_date | string(date-time) | true | none | none |
| most_comparable | boolean | true | none | none |
OfferLocalMarketResults
{
"count": 0,
"median_price": 0,
"comparable_price": 0,
"median_mileage": 0,
"comparable_mileage": 0,
"comparable_price_adjustment": 0,
"comparable_recondition_adjustment": 0,
"comparable_mileage_adjustment": 0,
"comparable_options_adjustment": 0,
"comparable_depreciation_adjustment": 0,
"comparable_overhead_adjustment": 0,
"comparable_total_adjustment": 0,
"expected_sell_days": 0,
"postal_code_location": [
0,
0
],
"results": [
{
"vin": "string",
"sale_type": "string",
"seller_type": "string",
"stock_number": "string",
"year": 0,
"make": "string",
"model": "string",
"style": "string",
"location": [
0
],
"distance": 0,
"status": "string",
"country": 0,
"mileage": 0,
"price": 0,
"exterior_color": "string",
"thumbnail": "string",
"vdp_link": "string",
"dom": 0,
"last_seen_date": "2019-08-24T14:15:22Z",
"most_comparable": true
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| count | integer | true | none | none |
| median_price | integer | true | none | none |
| comparable_price | integer | true | none | none |
| median_mileage | integer | true | none | none |
| comparable_mileage | integer | true | none | none |
| comparable_price_adjustment | integer | true | none | none |
| comparable_recondition_adjustment | integer | true | none | none |
| comparable_mileage_adjustment | integer | true | none | none |
| comparable_options_adjustment | integer | true | none | none |
| comparable_depreciation_adjustment | integer | true | none | none |
| comparable_overhead_adjustment | integer | true | none | none |
| comparable_total_adjustment | integer | true | none | none |
| expected_sell_days | integer | true | none | none |
| postal_code_location | [number] | true | none | none |
| results | [OfferLocalMarketResult] | true | none | none |
OfferOptInDealer
{
"dealer_id": [
0
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealer_id | [integer] | true | none | none |
PayoffData
{
"lender_id": "string",
"raw_data": {},
"payoff": 0,
"equity": 0,
"date_pulled": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lender_id | string | false | read-only | none |
| raw_data | object | false | none | none |
| payoff | number(decimal)¦null | false | none | none |
| equity | number(decimal)¦null | false | none | none |
| date_pulled | string(date-time) | true | none | none |
OfferPayoff
{
"lender": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lender | string | true | none | none |
OfferPriceReview
{
"price_review_vote": true,
"price_review_reason": 1,
"price_review_feedback_date": "2019-08-24",
"price_review_feedback_price": 0,
"price_review_feedback": "string",
"price_review_feedback_conditions": [
"low_mileage"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| price_review_vote | boolean¦null | false | none | none |
| price_review_reason | integer¦null | true | none | Enum Description: 1 - Still Considering 2 - Expected a Higher Price 3 - Not Ready To Sell 4 - Other 5 - Received Better Offer 6 - Selling Privately |
| price_review_feedback_date | string(date)¦null | false | none | none |
| price_review_feedback_price | integer¦null | false | none | none |
| price_review_feedback | string¦null | true | none | none |
| price_review_feedback_conditions | [string]¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| price_review_reason | 1 |
| price_review_reason | 2 |
| price_review_reason | 3 |
| price_review_reason | 4 |
| price_review_reason | 5 |
| price_review_reason | 6 |
OfferPricing
{
"total_adjustments": 0,
"vehicle_odor_adjustment": 0,
"mileage_adjustment": 0,
"postal_code_adjustment": 0,
"color_adjustment": 0,
"total_vacs_adjustment": 0,
"original_owner_adjustment": 0,
"key_fobs_adjustment": 0,
"insurance_payout_adjustment": 0,
"carfax_bad_vhr_adjustment": 0,
"external_damage_adjustment": 0,
"frame_damage_adjustment": 0,
"tire_adjustment": 0,
"approximate_condition_adjustment": 0,
"extended_warranty_adjustment": 0,
"title_adjustment": 0,
"salvage_title_adjustment": 0,
"fire_damage_adjustment": 0,
"flood_damage_adjustment": 0,
"hail_damage_adjustment": 0,
"stolen_adjustment": 0,
"mechanical_suspension_adjustment": 0,
"mechanical_sunroof_moonroof_adjustment": 0,
"mechanical_catalytic_converter_adjustment": 0,
"mechanical_engine_adjustment": 0,
"mechanical_brakes_adjustment": 0,
"mechanical_exhaust_adjustment": 0,
"mechanical_transmission_adjustment": 0,
"ac_adjustment": 0,
"mechanical_oil_leak_adjustment": 0,
"mechanical_head_gasket_adjustment": 0,
"warning_lights_4x4_adjustment": 0,
"warning_lights_abs_adjustment": 0,
"warning_lights_brake_adjustment": 0,
"warning_lights_engine_adjustment": 0,
"warning_lights_suspension_fault_adjustment": 0,
"warning_lights_airbag_adjustment": 0,
"warning_lights_battery_adjustment": 0,
"warning_lights_tpms_adjustment": 0,
"warning_lights_traction_control_adjustment": 0,
"modifications_suspension_lowered_adjustment": 0,
"modifications_suspension_raised_adjustment": 0,
"modifications_wheel_adjustment": 0,
"modifications_exhaust_adjustment": 0,
"modifications_catalytic_converter_adjustment": 0,
"modifications_aftermarket_tint_adjustment": 0,
"modifications_stereo_adjustment": 0,
"modifications_performance_adjustment": 0,
"modifications_sunroof_moonroof_adjustment": 0,
"modifications_spoiler_adjustment": 0,
"significant_issues_adjustment": 0,
"uploaded_photos_adjustment": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| total_adjustments | integer | true | none | none |
| vehicle_odor_adjustment | integer | true | none | none |
| mileage_adjustment | integer | true | none | none |
| postal_code_adjustment | integer | true | none | none |
| color_adjustment | integer | true | none | none |
| total_vacs_adjustment | integer | true | none | none |
| original_owner_adjustment | integer | true | none | none |
| key_fobs_adjustment | integer | true | none | none |
| insurance_payout_adjustment | integer | true | none | none |
| carfax_bad_vhr_adjustment | integer | true | none | none |
| external_damage_adjustment | integer | true | none | none |
| frame_damage_adjustment | integer | true | none | none |
| tire_adjustment | integer | true | none | none |
| approximate_condition_adjustment | integer | true | none | none |
| extended_warranty_adjustment | integer | true | none | none |
| title_adjustment | integer | true | none | none |
| salvage_title_adjustment | integer | true | none | none |
| fire_damage_adjustment | integer | true | none | none |
| flood_damage_adjustment | integer | true | none | none |
| hail_damage_adjustment | integer | true | none | none |
| stolen_adjustment | integer | true | none | none |
| mechanical_suspension_adjustment | integer | true | none | none |
| mechanical_sunroof_moonroof_adjustment | integer | true | none | none |
| mechanical_catalytic_converter_adjustment | integer | true | none | none |
| mechanical_engine_adjustment | integer | true | none | none |
| mechanical_brakes_adjustment | integer | true | none | none |
| mechanical_exhaust_adjustment | integer | true | none | none |
| mechanical_transmission_adjustment | integer | true | none | none |
| ac_adjustment | integer | true | none | none |
| mechanical_oil_leak_adjustment | integer | true | none | none |
| mechanical_head_gasket_adjustment | integer | true | none | none |
| warning_lights_4x4_adjustment | integer | true | none | none |
| warning_lights_abs_adjustment | integer | true | none | none |
| warning_lights_brake_adjustment | integer | true | none | none |
| warning_lights_engine_adjustment | integer | true | none | none |
| warning_lights_suspension_fault_adjustment | integer | true | none | none |
| warning_lights_airbag_adjustment | integer | true | none | none |
| warning_lights_battery_adjustment | integer | true | none | none |
| warning_lights_tpms_adjustment | integer | true | none | none |
| warning_lights_traction_control_adjustment | integer | true | none | none |
| modifications_suspension_lowered_adjustment | integer | true | none | none |
| modifications_suspension_raised_adjustment | integer | true | none | none |
| modifications_wheel_adjustment | integer | true | none | none |
| modifications_exhaust_adjustment | integer | true | none | none |
| modifications_catalytic_converter_adjustment | integer | true | none | none |
| modifications_aftermarket_tint_adjustment | integer | true | none | none |
| modifications_stereo_adjustment | integer | true | none | none |
| modifications_performance_adjustment | integer | true | none | none |
| modifications_sunroof_moonroof_adjustment | integer | true | none | none |
| modifications_spoiler_adjustment | integer | true | none | none |
| significant_issues_adjustment | integer | true | none | none |
| uploaded_photos_adjustment | integer | true | none | none |
RelatedOffer
{
"id": 0,
"status": "draft",
"type": "consumer",
"supervisor": {
"id": 0,
"archived": "2019-08-24T14:15:22Z",
"user": {
"id": 0,
"last_login": "2019-08-24T14:15:22Z",
"is_superuser": true,
"username": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_active": true,
"date_joined": "2019-08-24T14:15:22Z"
},
"profile_picture": {},
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"cell_phone": "string",
"home_phone": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"receives_pending_email": true,
"hvms_buyer_code": "string",
"description": "string",
"show_in_dealer_list": true,
"role": 200,
"is_on_call": true,
"company": 0
},
"offer_posted_time": "2019-08-24T14:15:22Z",
"source_system": {
"id": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z",
"name": "string",
"slug": "string",
"generates_offer_type": "consumer",
"origin_type_name": "string",
"generates_multiple_offers": true,
"does_report_events": true,
"lead_source_label": "string",
"user": 0,
"dealer_group": 0,
"company": 0,
"partner": 0
},
"created": "2019-08-24T14:15:22Z",
"trade_desk_view_url": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| type | string | false | none | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| supervisor | Staff | true | none | none |
| offer_posted_time | string(date-time)¦null | false | none | none |
| source_system | System | true | none | none |
| created | string(date-time) | false | read-only | none |
| trade_desk_view_url | string | false | read-only | none |
Enumerated Values
| Property | Value |
|---|---|
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| type | consumer |
| type | dealer |
| type | algol |
OfferPricingResultsOEMGTP
{
"oem_name": "string",
"gtp_price": 0,
"max_miles": 0,
"expiration": "2019-08-24",
"errors": [
"string"
],
"show_gtp": true
}
Details about an offer provided by an OEM program
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| oem_name | string | true | none | none |
| gtp_price | integer¦null | true | none | none |
| max_miles | integer¦null | true | none | none |
| expiration | string(date)¦null | true | none | none |
| errors | [string] | true | none | none |
| show_gtp | boolean | true | none | none |
OfferPricingResults
{
"vehicle_value": 0,
"mileage_value": 0,
"price_per_mile": 0,
"mileage_average": 0,
"mileage_current": 0,
"options_value": 0,
"options": {},
"color_adjustment": 0,
"condition_value": 0,
"condition_adjustments": {
"property1": "string",
"property2": "string"
},
"owed": 0,
"loan_payoff": 0,
"loan_equity": 0,
"trade_credit": 0,
"vehicle_range": [
"string"
],
"original_range": [
"string"
],
"vehicle_offer": 0,
"original_offer": 0,
"boosted_offer": true,
"boosted_value": 0,
"offer_ceiling": 0,
"barcode_value": "string",
"untaxed_amount": 0,
"state_tax": 0,
"dealer_sale_time": "string",
"dealer_tax_savings": 0,
"dealer_expected_depreciation": 0,
"private_expected_depreciation": 0,
"private_sale_time": "string",
"private_tax_savings": 0,
"selected_dealerships": [
"string"
],
"expired": true,
"expired_date": "2019-08-24T14:15:22Z",
"oem_gtp": {
"oem_name": "string",
"gtp_price": 0,
"max_miles": 0,
"expiration": "2019-08-24",
"errors": [
"string"
],
"show_gtp": true
},
"accident_adjustment": 0,
"market_average": 0,
"market_low": 0,
"market_high": 0,
"needs_dealer_review": true,
"outside_service_area": true,
"show_uploaded_photo_incentive": true,
"has_uploaded_photo_incentive": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| vehicle_value | integer | true | none | Vehicle value not counting mileage, options, color, condition, and boost |
| mileage_value | integer | true | none | Price adjustment due to vehicle mileage |
| price_per_mile | number(decimal) | true | none | Price adjustment per mile due to vehicle mileage |
| mileage_average | integer | true | none | Expected mileage for vehicle based on class and age |
| mileage_current | integer | true | none | Current mileage for vehicle |
| options_value | integer | true | none | Price adjustment due to vehicle options |
| options | object | false | read-only | Details about vehicle options |
| color_adjustment | integer | true | none | Price adjustment due to vehicle color |
| condition_value | integer | true | none | Price adjustment due to vehicle conditions |
| condition_adjustments | object | true | none | Details about vehicle conditions |
| » additionalProperties | string¦null | false | none | none |
| owed | integer | true | none | Amount owed on the vehicle |
| loan_payoff | number(decimal) | true | none | Loan payoff value |
| loan_equity | number(decimal) | true | none | Trade in equity (based on loan_payoff) |
| trade_credit | integer | true | none | Vehicle offer price minus any amount owed on the vehicle |
| vehicle_range | [string] | false | read-only | Final offer ranged value |
| original_range | [string] | false | read-only | Offer ranged value without any boost |
| vehicle_offer | integer | true | none | Final offer value |
| original_offer | integer | true | none | Offer value without any boost |
| boosted_offer | boolean | true | none | Flag indicating offer value was boosted |
| boosted_value | integer | true | none | Amount vehicle_offer was boosted by |
| offer_ceiling | integer | true | none | Amount to use on slider for max offer price consumer desires |
| barcode_value | string | true | none | Used to build barcode that can be used to access offer at dealership |
| untaxed_amount | integer | true | none | Untaxed amount of vehicle value |
| state_tax | number(decimal) | true | none | State tax rate for dealership |
| dealer_sale_time | string | true | none | Number of days it takes to sell vehicle to dealer |
| dealer_tax_savings | integer | true | none | Potential tax savings on dealer sale |
| dealer_expected_depreciation | number(decimal)¦null | true | none | Vehicle value daily depreciation in dealership context |
| private_expected_depreciation | integer | true | none | Vehicle value depreciation while waiting for private sale |
| private_sale_time | string | true | none | Number of days it takes to sell vehicle privately |
| private_tax_savings | integer | true | none | Potential tax savings on private sale |
| selected_dealerships | [string] | false | read-only | none |
| expired | boolean | true | none | Flag indicating if offer is currently expired |
| expired_date | string(date-time) | true | none | Time that offer will expire |
| oem_gtp | OfferPricingResultsOEMGTP | true | none | Details about an offer provided by an OEM program |
| accident_adjustment | integer | true | none | Unused |
| market_average | integer | true | none | Unused |
| market_low | integer | true | none | Unused |
| market_high | integer | true | none | Unused |
| needs_dealer_review | boolean | true | none | Flag indicating offer has conditions requiring dealer review |
| outside_service_area | boolean | true | none | Flag indicating offer consumer is beyond dealers service area |
| show_uploaded_photo_incentive | boolean | true | none | Flag indicating offer has potential for uploaded photo incentive |
| has_uploaded_photo_incentive | boolean | true | none | Flag indicating offer has applied uploaded photo incentive |
OfferSendToDealer
{
"id": "string",
"selection_type": "string",
"reason": "string",
"display_position": "string",
"scores": {},
"makes": "string",
"profile_url": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | none | none |
| selection_type | string | true | none | none |
| reason | string | true | none | none |
| display_position | string | true | none | none |
| scores | object | true | none | none |
| makes | string¦null | false | none | none |
| profile_url | string¦null | false | none | none |
DealershipSimple
{
"id": 0,
"name": "string",
"uuid": "string",
"company": 0,
"partner": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| name | string | true | none | none |
| uuid | string | false | none | none |
| company | integer | false | none | none |
| partner | integer¦null | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time)¦null | false | none | none |
SystemSimple
{
"id": 0,
"name": "string",
"slug": "string",
"company": 0,
"partner": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| name | string | true | none | none |
| slug | string(slug) | false | read-only | none |
| company | integer | false | none | none |
| partner | integer | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time)¦null | false | none | none |
OfferSimple
{
"id": 0,
"code": "f5d62b05-370e-48be-a755-8675ca146431",
"offer_short_code": "string",
"type": "consumer",
"plate_state": "st",
"plate_number": "string",
"vehicle_vin": "string",
"vehicle_year": -2147483648,
"vehicle_make": "string",
"vehicle_model": "string",
"vehicle_style": "string",
"vehicle_source": 1,
"vehicle_source_id": "string",
"vehicle_specialized": true,
"vehicle_mismatch": true,
"vehicle_image": "string",
"vehicle_includes": "string",
"vehicle_engine_type": "string",
"vehicle_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"color_adjustment": -2147483648,
"vehicle_interior_color": {
"id": 0,
"index": -2147483648,
"name": "string",
"hex_code": "string",
"slug": "string",
"ref_id": -2147483648
},
"vacs": [
{
"id": 0,
"description": "string",
"addded": "s",
"ref_id": -2147483648,
"amount": -2147483648,
"selected": true,
"offer": 0
}
],
"vehicle_mileage": -2147483648,
"vehicle_base_miles": -2147483648,
"mileage_adjustment": -2147483648,
"postal_code_adjustment": -2147483648,
"is_over_mileage": "string",
"approximate_condition": "excellent",
"is_original_owner": true,
"is_liened": true,
"liened_type": "loan",
"owed_amount": -2147483648,
"lease_monthly_payment": 0,
"lease_number_payments": -2147483648,
"lease_amount_remaining": 0,
"is_interested_new_vehicle": true,
"new_vehicle_type": "new",
"new_vehicle_year": -2147483648,
"new_vehicle_make": "string",
"new_vehicle_model": "string",
"new_vehicle_style": "string",
"new_vehicle_source": 1,
"new_vehicle_source_id": "string",
"has_accident": true,
"insurance_payout_amount": 0,
"insurance_payout_adjustment": -2147483648,
"has_frame_damage": true,
"frame_damage_adjustment": -2147483648,
"carfax_has_bad_vhr": true,
"carfax_bad_vhr_adjustment": -2147483648,
"has_external_damage": true,
"external_damage_amount": 0,
"front_tire_age": "poor",
"rear_tire_age": "poor",
"has_mechanical_issues": true,
"has_mechanical_ac": true,
"has_mechanical_brakes": true,
"has_mechanical_catalytic_converter": true,
"has_mechanical_engine": true,
"has_mechanical_exhaust": true,
"has_mechanical_head_gasket": true,
"has_mechanical_oil_leak": true,
"has_mechanical_sunroof_moonroof": true,
"has_mechanical_suspension": true,
"has_mechanical_transmission": true,
"has_mechanical_other": true,
"mechanical_other_note": "string",
"has_warning_lights": true,
"has_warning_lights_abs": true,
"has_warning_lights_srs": true,
"has_warning_lights_battery": true,
"has_warning_lights_brake": true,
"has_warning_lights_engine": true,
"has_warning_lights_tpms": true,
"has_warning_lights_suspension_fault": true,
"has_warning_lights_traction_control": true,
"has_modifications": true,
"has_modifications_exhaust": true,
"has_modifications_performance": true,
"has_modifications_stereo": true,
"has_modifications_spoiler": true,
"has_modifications_sunroof_moonroof": true,
"has_modifications_suspension_lifted": true,
"has_modifications_suspension_lowered": true,
"has_modifications_wheel": true,
"has_aftermarket_tint": true,
"has_odor": true,
"vehicle_odor_adjustment": -2147483648,
"has_other_issues": true,
"is_salvage_title": true,
"is_rebuilt_title": true,
"salvage_title_adjustment": -2147483648,
"has_fire_damage": true,
"has_flood_damage": true,
"was_stolen": true,
"other_issues_repair_cost": 0,
"consumer": 0,
"expect_transact_months": 0,
"status": "draft",
"needs_dealer_review": "string",
"offer_posted_time": "2019-08-24T14:15:22Z",
"pricing_type": "ranged",
"pricing_country": 1,
"vehicle_trade_price": -2147483648,
"vehicle_market_price": -2147483648,
"vehicle_base_price": -2147483648,
"vehicle_price": "string",
"range_low": -2147483648,
"range_high": -2147483648,
"guaranteed_price": -2147483648,
"vehicle_offer_price": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"expired": "string",
"is_dsa_offer": true,
"assigned_dealerships": [
0
],
"dealer": {
"id": 0,
"name": "string",
"uuid": "string",
"company": 0,
"partner": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"source_system": {
"id": 0,
"name": "string",
"slug": "string",
"company": 0,
"partner": 0,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
},
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"partner": "string",
"offer_return_link": "string",
"is_testing": true,
"created": "2019-08-24T14:15:22Z",
"modified": "2019-08-24T14:15:22Z",
"archived": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | false | read-only | none |
| code | string(uuid) | false | read-only | none |
| offer_short_code | string | false | read-only | none |
| type | string | false | none | Enum Description: consumer - Consumer dealer - Dealer algol - ALGol |
| plate_state | string¦null | false | none | none |
| plate_number | string¦null | false | none | none |
| vehicle_vin | string¦null | false | none | none |
| vehicle_year | integer | true | none | none |
| vehicle_make | string | true | none | none |
| vehicle_model | string | true | none | none |
| vehicle_style | string | true | none | none |
| vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| vehicle_source_id | string¦null | false | none | none |
| vehicle_specialized | boolean¦null | false | none | none |
| vehicle_mismatch | boolean¦null | false | none | none |
| vehicle_image | string¦null | false | none | none |
| vehicle_includes | string¦null | false | none | none |
| vehicle_engine_type | string¦null | false | none | none |
| vehicle_color | Color | true | none | none |
| color_adjustment | integer | false | none | none |
| vehicle_interior_color | Color | true | none | none |
| vacs | [OfferVac] | true | none | none |
| vehicle_mileage | integer¦null | false | none | none |
| vehicle_base_miles | integer¦null | false | none | none |
| mileage_adjustment | integer | false | none | none |
| postal_code_adjustment | integer | false | none | none |
| is_over_mileage | string | false | read-only | none |
| approximate_condition | string¦null | false | none | Enum Description: excellent - Excellent good - Good fair - Fair poor - Poor |
| is_original_owner | boolean¦null | false | none | none |
| is_liened | boolean¦null | false | none | none |
| liened_type | string¦null | false | none | Enum Description: loan - Loan lease - Lease |
| owed_amount | integer¦null | false | none | none |
| lease_monthly_payment | number(decimal)¦null | false | none | none |
| lease_number_payments | integer¦null | false | none | none |
| lease_amount_remaining | number(decimal)¦null | false | none | none |
| is_interested_new_vehicle | boolean¦null | false | none | none |
| new_vehicle_type | string¦null | false | none | Enum Description: new - New used - Used cpo - CPO undecided - Not Sure |
| new_vehicle_year | integer¦null | false | none | none |
| new_vehicle_make | string¦null | false | none | none |
| new_vehicle_model | string¦null | false | none | none |
| new_vehicle_style | string¦null | false | none | none |
| new_vehicle_source | integer¦null | false | none | Enum Description: 1 - Galves 2 - Chrome 3 - HVMS |
| new_vehicle_source_id | string¦null | false | none | none |
| has_accident | boolean¦null | false | none | none |
| insurance_payout_amount | number(decimal)¦null | false | none | none |
| insurance_payout_adjustment | integer | false | none | none |
| has_frame_damage | boolean¦null | false | none | none |
| frame_damage_adjustment | integer | false | none | none |
| carfax_has_bad_vhr | boolean¦null | false | none | none |
| carfax_bad_vhr_adjustment | integer | false | none | none |
| has_external_damage | boolean¦null | false | none | none |
| external_damage_amount | number(decimal)¦null | false | none | none |
| front_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| rear_tire_age | string¦null | false | none | Enum Description: poor - Poor good - Good excellent - Excellent |
| has_mechanical_issues | boolean¦null | false | none | none |
| has_mechanical_ac | boolean¦null | false | none | none |
| has_mechanical_brakes | boolean¦null | false | none | none |
| has_mechanical_catalytic_converter | boolean¦null | false | none | none |
| has_mechanical_engine | boolean¦null | false | none | none |
| has_mechanical_exhaust | boolean¦null | false | none | none |
| has_mechanical_head_gasket | boolean¦null | false | none | none |
| has_mechanical_oil_leak | boolean¦null | false | none | none |
| has_mechanical_sunroof_moonroof | boolean¦null | false | none | none |
| has_mechanical_suspension | boolean¦null | false | none | none |
| has_mechanical_transmission | boolean¦null | false | none | none |
| has_mechanical_other | boolean¦null | false | none | none |
| mechanical_other_note | string | false | none | none |
| has_warning_lights | boolean¦null | false | none | none |
| has_warning_lights_abs | boolean¦null | false | none | none |
| has_warning_lights_srs | boolean¦null | false | none | none |
| has_warning_lights_battery | boolean¦null | false | none | none |
| has_warning_lights_brake | boolean¦null | false | none | none |
| has_warning_lights_engine | boolean¦null | false | none | none |
| has_warning_lights_tpms | boolean¦null | false | none | none |
| has_warning_lights_suspension_fault | boolean¦null | false | none | none |
| has_warning_lights_traction_control | boolean¦null | false | none | none |
| has_modifications | boolean¦null | false | none | none |
| has_modifications_exhaust | boolean¦null | false | none | none |
| has_modifications_performance | boolean¦null | false | none | none |
| has_modifications_stereo | boolean¦null | false | none | none |
| has_modifications_spoiler | boolean¦null | false | none | none |
| has_modifications_sunroof_moonroof | boolean¦null | false | none | none |
| has_modifications_suspension_lifted | boolean¦null | false | none | none |
| has_modifications_suspension_lowered | boolean¦null | false | none | none |
| has_modifications_wheel | boolean¦null | false | none | none |
| has_aftermarket_tint | boolean¦null | false | none | none |
| has_odor | boolean¦null | false | none | none |
| vehicle_odor_adjustment | integer | false | none | none |
| has_other_issues | boolean¦null | false | none | none |
| is_salvage_title | boolean¦null | false | none | none |
| is_rebuilt_title | boolean¦null | false | none | none |
| salvage_title_adjustment | integer | false | none | none |
| has_fire_damage | boolean¦null | false | none | none |
| has_flood_damage | boolean¦null | false | none | none |
| was_stolen | boolean¦null | false | none | none |
| other_issues_repair_cost | number(decimal)¦null | false | none | none |
| consumer | integer¦null | false | none | none |
| expect_transact_months | integer¦null | false | none | Enum Description: 0 - Ready to sell now 2 - 2 - 6 months 100 - Curious |
| status | string | false | none | Enum Description: draft - Draft pending - Pending dealer-review - Dealer Review accepted - Accepted rejected - Rejected advanced_no_dealer - Advanced No Dealer advanced - Advanced trade-desk-review - Trade Desk Review purchased - Purchased |
| needs_dealer_review | string | false | read-only | none |
| offer_posted_time | string(date-time)¦null | false | none | none |
| pricing_type | string | false | none | Enum Description: ranged - Ranged gp - Guaranteed Price estimate - Estimate ymmt_gp - YMMT Guaranteed Price |
| pricing_country | integer | false | none | Enum Description: 1 - United States 2 - Canada |
| vehicle_trade_price | integer¦null | false | none | none |
| vehicle_market_price | integer¦null | false | none | none |
| vehicle_base_price | integer¦null | false | none | none |
| vehicle_price | string | false | read-only | none |
| range_low | integer¦null | false | none | none |
| range_high | integer¦null | false | none | none |
| guaranteed_price | integer¦null | false | none | none |
| vehicle_offer_price | string | false | read-only | none |
| expiration_date | string(date-time) | false | read-only | none |
| expired | string | false | read-only | none |
| is_dsa_offer | boolean¦null | false | none | none |
| assigned_dealerships | [integer] | false | read-only | none |
| dealer | DealershipSimple | true | none | none |
| source_system | SystemSimple | true | none | none |
| company | string(uuid) | false | read-only | none |
| partner | string | false | read-only | none |
| offer_return_link | string¦null | false | none | none |
| is_testing | boolean | false | none | none |
| created | string(date-time) | false | read-only | none |
| modified | string(date-time) | false | read-only | none |
| archived | string(date-time)¦null | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| type | consumer |
| type | dealer |
| type | algol |
| vehicle_source | 1 |
| vehicle_source | 2 |
| vehicle_source | 3 |
| approximate_condition | excellent |
| approximate_condition | good |
| approximate_condition | fair |
| approximate_condition | poor |
| liened_type | loan |
| liened_type | lease |
| new_vehicle_type | new |
| new_vehicle_type | used |
| new_vehicle_type | cpo |
| new_vehicle_type | undecided |
| new_vehicle_source | 1 |
| new_vehicle_source | 2 |
| new_vehicle_source | 3 |
| front_tire_age | poor |
| front_tire_age | good |
| front_tire_age | excellent |
| rear_tire_age | poor |
| rear_tire_age | good |
| rear_tire_age | excellent |
| expect_transact_months | 0 |
| expect_transact_months | 2 |
| expect_transact_months | 100 |
| status | draft |
| status | pending |
| status | dealer-review |
| status | accepted |
| status | rejected |
| status | advanced_no_dealer |
| status | advanced |
| status | trade-desk-review |
| status | purchased |
| pricing_type | ranged |
| pricing_type | gp |
| pricing_type | estimate |
| pricing_type | ymmt_gp |
| pricing_country | 1 |
| pricing_country | 2 |
VehicleDataOptionSerializerV1
{
"id": 0,
"desc": "string",
"addded": "string",
"inc": true,
"ro": true,
"exc": [
0
],
"mutex": [
0
],
"disabled": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer | true | none | Option reference ID |
| desc | string | true | none | Option description |
| addded | string | true | none | Option add (A) or deduct (D) |
| inc | boolean | true | none | Option selected indicator, sometimes this will default to true indicating the option is known to be part of the vehicle |
| ro | boolean | true | none | Deprecated do not use |
| exc | [integer]¦null | true | none | Deprecated do not use |
| mutex | [integer]¦null | true | none | Option mutually exclusive data, if this option is selected than any option id in this array should not be selected in user interface |
| disabled | boolean | true | none | Option disabled indicator, when disabled do not allow toggling in user interface |
VehicleDataSerializerV1
{
"source": 0,
"gid": "string",
"guid": "string",
"book": "string",
"year": 0,
"make": "string",
"model": "string",
"webmodel": "string",
"style": "string",
"body": "string",
"engtype": "string",
"vehicle_class": "string",
"basemiles": 0,
"includes": "string",
"vacs": [
{
"id": 0,
"desc": "string",
"addded": "string",
"inc": true,
"ro": true,
"exc": [
0
],
"mutex": [
0
],
"disabled": true
}
],
"specialized": true,
"vehicle_mismatch": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | integer | true | none | none |
| gid | string | true | none | none |
| guid | string | true | none | none |
| book | string | true | none | none |
| year | integer | true | none | none |
| make | string | true | none | none |
| model | string | true | none | none |
| webmodel | string | true | none | none |
| style | string | true | none | none |
| body | string | true | none | none |
| engtype | string | true | none | none |
| vehicle_class | string | true | none | none |
| basemiles | integer | true | none | none |
| includes | string | true | none | none |
| vacs | [VehicleDataOptionSerializerV1] | true | none | none |
| specialized | boolean | true | none | none |
| vehicle_mismatch | boolean | false | none | none |
VehicleDataOptionSerializerV2
{
"ref_id": 0,
"description": "string",
"addded": "string",
"selected": true,
"mutex": [
0
],
"disabled": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ref_id | integer | true | none | Option reference ID |
| description | string | true | none | Option description |
| addded | string | true | none | Option add (A) or deduct (D) |
| selected | boolean | true | none | Option selected indicator, sometimes this will default to true indicating the option is known to be part of the vehicle |
| mutex | [integer]¦null | true | none | Option mutually exclusive data, if this option is selected than any option ref_id in this array should not be selected in user interface |
| disabled | boolean | true | none | Option disabled indicator, when disabled do not allow toggling in user interface |
VehicleDataSerializerV2
{
"source": 0,
"gid": "string",
"book": "string",
"year": 0,
"make": "string",
"model": "string",
"trim": "string",
"style": "string",
"body": "string",
"engine": "string",
"vehicle_class": "string",
"base_mileage": 0,
"standard_equipment": "string",
"options": [
{
"ref_id": 0,
"description": "string",
"addded": "string",
"selected": true,
"mutex": [
0
],
"disabled": true
}
],
"specialized": true,
"vin_gid_mismatch": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| source | integer | true | none | none |
| gid | string | true | none | none |
| book | string | true | none | none |
| year | integer | true | none | none |
| make | string | true | none | none |
| model | string | true | none | none |
| trim | string | true | none | none |
| style | string | true | none | none |
| body | string | true | none | none |
| engine | string | true | none | none |
| vehicle_class | string | true | none | none |
| base_mileage | integer | true | none | none |
| standard_equipment | string | true | none | none |
| options | [VehicleDataOptionSerializerV2] | true | none | none |
| specialized | boolean | true | none | none |
| vin_gid_mismatch | boolean | false | none | none |