Vehicles API v2024-11-01 Use Case Guide
How to use the Vehicles API.
With the Selling Partner API for Vehicles (Vehicles API), you can retrieve information about vehicles, including their unique identifiers. You can use this information to provide compatibility information for listed ASINs with the Listings API.
Items that require vehicle fitment information require a list of vehicle KTYPEs. This API provides a list of vehicles and their KTYPE, which you can use to independently map each item in your catalog to a list of KTYPEs. This mapping can then be provided to Amazon using the Listings API.
What is in this guide?
This guide describes how to:
- Use the Vehicles API to get the latest list of vehicles.
- Update the fitment information for an ASIN using the Listings API.
Tutorial: Provide fitment information on ASINs
Provide compatibility information for items in your catalog.
Prerequisites
To complete this tutorial, you must have:
- Authorization from the selling partner for whom you are making calls. Refer to the Authorizing Selling Partner API applications for more information.
- Approval for the Product Listing role in your developer profile.
- The Product Listing role selected in the App registration page for your application.
Step 1. Retrieve a list of vehicles and their KTYPEs
To get a list of vehicles, call the getVehicles
operation.
Step 2. Map your items to KTYPEs
Use the response from the previous step to select vehicles that your items fit. For each item, record the KTYPE of the vehicles that fit it. You provide this list of KTYPEs in the next step.
Step 3. Update the fitment with the Listings API
To update fitment information on an ASIN, call the patchListingsItem
operation. The patches
parameter in the request body should have the path
equal to /attributes/vehicle_fitment
and contain the list of KTYPEs in value
.
Request example
PATCH https://sellingpartnerapi-eu.amazon.com/listings/2021-08-01/items/XXXXXXXXXX/SKU_XXXXXX?includedData=issues&marketplaceIds=A1PA6795UKMFR9
{
"productType": "AUTO_OIL",
"patches": [
{
"op": "replace",
"path": "/attributes/vehicle_fitment",
"value": [
{
"standard": [
{
"value": "ktype",
"language_tag": "de_DE"
}
],
"code": [
{
"value": "10232, 10234, 10233",
"language_tag": "de_DE"
}
],
"note": [
{
"value": "{\"10232,10234\":[[[\"Fahrwerk\",\"für Fahrzeuge mit M-Technik\"]]],\"10233\":[[[\"Fahrwerk\",\"für Fahrzeuge mit M-Technik\"],[\"Motorcode\",\"N47 D20 C\"]]]}",
"language_tag": "de_DE"
}
],
"marketplace_id": "A1PA6795UKMFR9"
}
]
}
]
}
Terms of use
When downloading and using the data provided by this API, the terms of use found here apply and are accepted by users.
Updated 9 days ago