Incentive Repository

The Incentive repository provides information according to the available Vehicle Incentives offered by automotive manufacturers.

Go to:

• URL
• Response Format
• Sample Request
• Available Methods

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/{method}

Response Formattop

All method responsed are JSON obects with a root property called, incentiveHolder. The value of incentiveHolder is an array of Incentive objects:

{
    "incentiveHolder": [
        incentive_object_1,
        incentive_object_2,
        incentive_object_3, 
        ....
        ....
     ]
}

Each Incentive object is a JSON object of the following format:

{
    "id": [integer],
    "type": [string],
    "contentType": [string],
    "sourceType": [string],
    "startDate": [date],
    "endDate": [date],
    "comments": [string],
    "restrictions": [string],
    "name": [string],
    "primary": [boolean],
    "incentiveVehicles" [array],
    "zipcodeExceptions: [array],
    "categories": [array],
    "incentiveType": [string],
    "makeIds": [array],
    "styleIds": [array],
    "rebateAmount": [integer], // Only available for type = "CASH_REBATE"
    "termMonths": [integer], // Only available for type = "LOW_APR"
    "apr": [float], // Only available for type = "LOW_APR"
    "creditRatingTier": [string] // Only available for type = "LOW_APR"
}

The properties of the Make object are:

• id: The incentive ID
• type: Type of incentive (CASH_REBATE, LOW_APR)
• contentType: To whom this incentive applies
• sourceType: The source of the incentive data
• startDate: The starting date for this incentive
• endDate: The ending date for this incentive
• comments: Comments about the incetive
• restrictions: Restriction on the incentive
• name: The name of the incentive
• primary: Is this a primary incentive?
• incentiveVehicles: An array of links to the Incentive Vehicle details
• zipcodeExceptions: An array of zipcode to which this incentive does NOT apply
• categories: The gategories of vehicles to which this incentive applies
• incentiveType: The type of the incentive
• makeIds: An array of links to vehicle makes
• styleIds: An array of links to vehicle styles
• rebateAcount: For "CASH_REBATE" incentives, this is the rebate amount
• apr: For "LOW_APR" incentives, this is the APR amount
• creditRatingTier: For "LOW_APR" incentives, this is the credit rating tier it applies to

Sample Requesttop

http://api.edmunds.com/v1/api/incentive/incentiverepository/findincentivesbystyleidandzipcode?styleid=101287989&zipcode=90019&api_key=xxx&fmt=json
 

Sample Response

{
    "incentiveHolder": [
        {
            "termMonths": 36,
            "apr": 1.9,
            "creditRatingTier": "Tier 1",
            "id": 2256661,
            "type": "LOW_APR",
            "contentType": "CUSTOMER_APR",
            "sourceType": "UNKNOWN",
            "subprogramId": 621151,
            "startDate": "2011-07-06",
            "endDate": "2011-08-01",
            "comments": "Dealer participation may vary. Incentives and Rebates are provided subject to the terms of our Visitor Agreement.",
            "restrictions": " Vehicle must be financed through the manufacturer's captive finance company. ",
            "name": "BMW 1.9-3.9 APR National",
            "primary": false,
            "incentiveVehicles": [
                {
                    "link": "/api/incentive/incentivevehicle/35171"
                },
                {
                    "link": "/api/incentive/incentivevehicle/33061"
                },
                {
                    "link": "/api/incentive/incentivevehicle/33060"
                },
                {
                    "link": "/api/incentive/incentivevehicle/35277"
                },
                {
                    "link": "/api/incentive/incentivevehicle/34755"
                }
            ],
            "zipcodeExceptions": [],
            "categories": [
                "Large",
                "SUV",
                "Hybrid",
                "Coupe",
                "Car",
                "Crossover",
                "Convertible",
                "Sedan",
                "Midsize",
                "Compact",
                "Factory Tuner",
                "Luxury",
                "Wagon",
                "Performance",
                "4dr SUV",
                "High-Performance"
            ],
            "regions": [
                "i397"
            ],
            "incentiveType": "lowAPR",
            "optionIds": [],
            "makeIds": [
                {
                    "link": "/api/vehicle/make/200000081"
                }
            ],
            "styleIds": [
                {
                    "link": "/api/vehicle/style/101288753"
                },
                {
                    "link": "/api/vehicle/style/101288752"
                },
                {
                    "link": "/api/vehicle/style/101288727"
                },
                {
                    "link": "/api/vehicle/style/101288728"
                },
                {
                    "link": "/api/vehicle/style/101266492"
                }
            ]
        },
        {
            "termMonths": 36,
            "apr": 0.9,
            "creditRatingTier": "Tier 1",
            "id": 2257172,
            "type": "LOW_APR",
            "contentType": "CUSTOMER_APR",
            "sourceType": "UNKNOWN",
            "subprogramId": 621278,
            "startDate": "2011-07-06",
            "endDate": "2011-08-01",
            "comments": "Dealer participation may vary. Incentives and Rebates are provided subject to the terms of our Visitor Agreement.",
            "restrictions": "Loyalty APR is available to customers who currently finance or lease through BMW Financial Services or have within the past 6 months. Trade-in is not required and this offer can be extended to individuals residing in the same household. Must finance through BMW Financial Services.",
            "name": "BMW Loyalty 1.9-3.9 APR National",
            "primary": false,
            "incentiveVehicles": [
                {
                    "link": "/api/incentive/incentivevehicle/35171"
                },
                {
                    "link": "/api/incentive/incentivevehicle/33061"
                },
                {
                    "link": "/api/incentive/incentivevehicle/33060"
                }
            ],
            "zipcodeExceptions": [],
            "categories": [
                "Large",
                "SUV",
                "Hybrid",
                "Coupe",
                "Car",
                "Crossover",
                "Convertible",
                "Sedan",
                "Midsize",
                "Compact",
                "Factory Tuner",
                "Luxury",
                "Wagon",
                "Performance",
                "4dr SUV",
                "High-Performance"
            ],
            "regions": [
                "i397"
            ],
            "incentiveType": "lowAPR",
            "optionIds": [],
            "makeIds": [
                {
                    "link": "/api/vehicle/make/200000081"
                }
            ],
            "styleIds": [
                {
                    "link": "/api/vehicle/style/101288753"
                },
                {
                    "link": "/api/vehicle/style/101288752"
                },
                {
                    "link": "/api/vehicle/style/101288727"
                },
                {
                    "link": "/api/vehicle/style/101288728"
                }
            ]
        },
        ...
        ...
    ]
}

Available Methodstop

Method: findbyid

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findbyid?id=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters

Method: findincentivesbycategoryandzipcode

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findincentivesbycategoryandzipcode?category=xxx&zipcode=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters

Method: findincentivesbymakeid

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findincentivesbymakeid?makeid=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters

Method: findincentivesbymakeidandzipcode

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findincentivesbymakeidandzipcode?makeid=xxx&zipcode=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters

Method: findincentivesbymodelyearidandzipcode

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findincentivesbymodelyearidandzipcode?modelyearid=xxx&zipcode=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters

Method: findincentivesbystyleid

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findincentivebystyleid?styleid=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters

Method: findincentivesbystyleidandzipcode

URL

http://api.edmunds.com/{version}/api/incentive/incentiverepository/findincentivesbystyleidandzipcode?styleid=xxx&zipcode=xxx&api_key=xxxxxxxxxx&fmt=json

Parameters