Vehicles 2024-11-01 Reference
Use the Vehicles API to programmatically retrieve identifiers for vehicles
The Selling Partner API for Automotive provides programmatic access to information needed by selling partners to provide compatibility information about their listed products.
Version information
Version : 2024-11-01
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
Paths
GET /catalog/2024-11-01/automotive/vehicles
Operation: getVehicles
Description
Get the latest collection of vehicles.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | pageToken optional | A token that is used to retrieve the next page or previous page of results. The response includes pagination when the number of results exceeds the page size. To get the next page of results, call the operation with the nextToken and include the same arguments as the call that produced the token. To get a complete list, call this operation until there is no nextToken in the response. Note that this operation can return empty pages. | string |
| Query | marketplaceId required | An identifier for the marketplace in which the resource operates. To find the ID for a marketplace, refer to Marketplace IDs. | string |
| Query | vehicleType required | The type of vehicle. | enum (VehicleType) |
| Query | updatedAfter optional | Include this field to only retrieve vehicles that have been modified or added to Amazon's catalog after the date you provide. Must be in ISO 8601 date-time format. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | VehiclesResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | The resource specified does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 413 | The request size exceeded the maximum accepted size. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
VehiclesResponse
A paginated list of vehicles from Amazon's catalog.
| Name | Description | Schema |
|---|---|---|
| pagination optional | The nextToken and previousToken values required to retrieve the next or previous page of results, if available. | Pagination |
| vehicles required | A list of vehicles from Amazon's catalog. | < Vehicle > array |
Pagination
When a request produces a response that exceeds the page size, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object.
| Name | Description | Schema |
|---|---|---|
| nextToken optional | A token that can be used to retrieve the next page. | string |
| previousToken optional | A token that can be used to retrieve the previous page. | string |
Vehicle
Combinations of attributes and unique identifiers that represent a vehicle.
| Name | Description | Schema |
|---|---|---|
| make required | The brand of the vehicle. | string |
| model required | The specific model of the vehicle. | string |
| variantName optional | The name of the vehicle variant. | string |
| bodyStyle optional | The body style of the vehicle. For example: hatchback, cabriolet. | string |
| driveType optional | The drive type of the vehicle. For example: rear wheel drive. | string |
| energy optional | The energy source of the vehicle. For example: petrol. | string |
| engineOutput optional | The power output of the vehicle's engine. | < EngineOutput > array |
| manufacturingStartDate optional | The vehicle's manufacturing start date. | MonthAndYear |
| manufacturingStopDate optional | The vehicle's manufacturing stop date. If this value is empty, then the vehicle is still being manufactured. | MonthAndYear |
| lastProcessedDate optional | The date on which the vehicle was last updated, in ISO-8601 date-time format. | string |
| status optional | Denotes if the vehicle is active or deleted from Amazon's catalog. | VehicleStatusInCatalog |
| identifiers required | Identifiers that can be used to identify the vehicle uniquely. | < VehicleIdentifiers > array |
EngineOutput
The power output of the vehicle's engine.
| Name | Description | Schema |
|---|---|---|
| value required | The engine power value in the specified unit. | number |
| unit required | The unit for measuring engine power. | EngineOutputUnit |
VehicleIdentifiers
The vehicle standard and ID that can uniquely identify a vehicle from Amazon's catalog.
| Name | Description | Schema |
|---|---|---|
| standard required | The vehicle standard used to uniquely identify a vehicle. | VehicleStandard |
| value required | The ID that can uniquely identify a vehicle based the vehicle identification standard. | string |
VehicleStandard
The standard followed to uniquely identify a vehicle.
Type : enum
| Value | Description |
|---|---|
| KTYPE | The unique vehicle identification standard as provided by TecDoc. |
| AMAZON_ID | The unique vehicle identification standard as provided by Amazon. |
EngineOutputUnit
Unit for measuring engine power.
Type : enum
| Value | Description |
|---|---|
| KILOWATT | The engine's power is measured in kilowatts. |
| HORSEPOWER | The engine's power is measure in horsepower. |
ErrorList
A list of error responses returned when a request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors required | A list of errors. | < Error > array |
Error
Error response returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. | string |
| message required | A message that describes the error condition. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
MonthAndYear
The month and year.
Year
The year in YYYY format.
Type : number
Pattern : ^[0-9]{4}$
Month
The month in MM format.
Type : number
Pattern : ^(0?[1-9]|1[012])$
VehicleStatusInCatalog
The status of the vehicle in Amazon's catalog.
Type : enum
| Value | Description |
|---|---|
| ACTIVE | The vehicle is active in Amazon's catalog. |
| DELETED | The vehicle is deleted from Amazon's catalog. |
VehicleType
The type of vehicle.
Type : enum
| Value | Description |
|---|---|
| CAR | Selecting this will return a list of cars. |
| MOTORBIKE | Selecting this will return a list of motorbikes and motorcycles. |
Updated about 4 hours ago