v2.product.get_vehicle_list_by_compatibility_detail
GET /api/v2/product/get_vehicle_list_by_compatibility_detail
Use this Open API to get vehicle list by brand, model, year, and version.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/product/get_vehicle_list_by_compatibility_detail
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| compatibility_details | string | True | Brand | To inform compatibility list, can be equal to Brand, Model, Year, or Version. Pass the compatibility_details="Brand" to get all brand list; Pass the compatibility_details="Model" and brand_id=1234 to get all model list under brand_id=1234; Pass the compatibility_details="Year" and brand_id=1234 and model_id=2345 to get all year list under brand_id=1234 and model_id=2345; Pass the compatibility_details="Version" and brand_id=1234 and model_id=2345 and year_id=3456 to get all version list under brand_id=1234 and model_id=2345 and year_id=3456. |
| brand_id | int64 | False | 1234 | ID of the brand. |
| model_id | int64 | False | 2345 | ID of the model. |
| year_id | int64 | False | 3456 | ID of the year. |
| language | string | False | pt-br | If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ; BR: en / pt-br ; MX: en / es-mx ; CO: en/es-CO ; CL: en/es-CL. Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Indicate waring details if hit waring. Empty if no waring happened. | |
| request_id | string | The identifier for an API request for error tracking | |
| response | object | ||
| vehicle_list | object[] | ||
| brand_id | int64 | 1234 | ID of the brand. |
| brand_name | string | Toyota | Name of the brand. |
| model_id | int64 | 2345 | ID of the model. |
| model_name | string | Etios | Name of the model. |
| year_id | int64 | 3456 | ID of the year. |
| year_name | string | 2023 | Name of the year. |
| version_id | int64 | 4567 | ID of the version. |
| version_name | string | 1.0 | Name of the version. |