Quote / Variants

Get photos for a specific variant

Get list of photo codes and corresponding types for a given vehicle variant. Photo codes are provided by the vehicle data supplier, and are typically used as the file name for each image. Types describe the orientation of the photo e.g. 'front'.

GET

/qt/variants/photos

curl --request GET \
  --url 'https://api.catch-e.com/qt/variants/photos?variant_id=%3Cstring%3E&photo_type=front' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "qt_variant_photos": [
      {
        "data_source_id": "<string>",
        "description": "<string>",
        "photo_code": "<string>",
        "photo_id": "<string>",
        "photo_type": "front",
        "photo_uri": "<string>",
        "variant_id": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/qt/variant/photos"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

This method requires the QuoteVariants:Get permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

variant_idstringqueryrequired

Variant Id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

photo_typeenum<string>[]query

Optional Photo Types

Maximum array length: 5

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team