How to get BrandYear for a Dealer

Get the brands a dealer services, and the model years available for each brand.

Use the brandUuid from this response with How to get Year Model for a Brand to get the models for each year.

For errors that this endpoint can return, see Get BrandYear for dealer — Errors.

Request

HTTP request

POST  https://api.mykaarma.com/appointment/v2/dealer-vehicle-config/brand-years

Authorization

This request requires the following authorization scopes:

Scope	Level	Description
dealer.vehicle.config.read	Dealer	Authorises client to read vehicle config for the provided dealer

Request Body

Property Name	Value	Description	Required
dealerUUIDList	List<String>	List of dealer UUIDs. Only the first UUID in the list is used.	Yes

Sample Request Model

{
  "dealerUUIDList": [
    "string"
  ]
}

Sample Curl

curl --location 'https://api.mykaarma.com/appointment/v2/dealer-vehicle-config/brand-years' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{basic_auth_token}}' \
--data '{
  "dealerUUIDList": [
    "cb731d36fd635ddd6ef8dd43500892b0c0249d1c01a46dbcc445a809c0a8e3b2"
  ]
}'

Response

mapOfDealerAndBrandYears has a single key: the dealer UUID from the request. Its brands are sorted by brandName, and each brand's years are sorted newest first. If the dealer is not found or has no brands set up, mapOfDealerAndBrandYears is null.

Property Name	Value	Description
mapOfDealerAndBrandYears	Map<String, List<DealerBrandYears>>	Brands for the dealer, keyed by dealer UUID
...[].brandName	String	Brand name, for example "Honda"
...[].brandUuid	String	Brand UUID. Pass this as brandUuid to the Year Model endpoint.
...[].brandId	Long	Numeric brand ID. Use brandUuid when calling the Year Model endpoint.
...[].brandLogo	String	URL of the brand logo
...[].webSchedulerMobileServiceImageURL	String	URL of the brand's mobile service image, if set up
...[].years	List<String>	Model years available for the brand. null if no vehicle configuration is found for the brand.
statusCode	Integer	Not set by this endpoint; always null
error	ApiError	Error details, if the request failed

Sample Response

{
  "mapOfDealerAndBrandYears": {
    "cb731d36fd635ddd6ef8dd43500892b0c0249d1c01a46dbcc445a809c0a8e3b2": [
      {
        "brandName": "string",
        "brandId": 0,
        "brandUuid": "string",
        "brandLogo": "string",
        "webSchedulerMobileServiceImageURL": "string",
        "years": [
          "2026",
          "2025",
          "2024"
        ]
      }
    ]
  },
  "statusCode": null,
  "error": null
}

Sample Error Response

Returned with HTTP 400 when dealerUUIDList is missing or empty.

{
  "mapOfDealerAndBrandYears": null,
  "statusCode": null,
  "error": {
    "errorCode": "DEALER_UUID_MISSING",
    "errorDescription": "Dealer UUID has not been provided",
    "errorUID": "string"
  }
}