Quote / Variants

Get a list of variants

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

GET

/qt/variants

curl --request GET \
  --url 'https://api.catch-e.com/qt/variants?make_id=%3Cstring%3E&model_id=%3Cstring%3E&model_year=123&variant_code=%3Cstring%3E&variant_name=%3Cstring%3E&body_type_id=%3Cstring%3E&data_source_id=%3Cstring%3E&profile_required_flag=yes&include_inactive_flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "qt_variants": [
      {
        "acceleration": 123,
        "adblue_capacity": 123,
        "air_pollution_rating": 123,
        "ancap_rating": 123,
        "average_retail_net": 123,
        "average_wholesale_net": 123,
        "battery_ac_charge_outlet": "<string>",
        "battery_ac_fast_charge": "<string>",
        "battery_capacity": 123,
        "battery_charge_socket_type": "<string>",
        "battery_dc_fast_charge": "<string>",
        "battery_warranty_kms": 123,
        "battery_warranty_years": 123,
        "body_type_id": "<string>",
        "build_year": 123,
        "cam": "<string>",
        "co2_emissions": 123,
        "configuration": "<string>",
        "country": "<string>",
        "current_vehicle_flag": "N",
        "cylinders": 123,
        "data_source_id": "<string>",
        "description": "<string>",
        "doors": 123,
        "drive_type": "<string>",
        "electric_engine_km_range": 123,
        "energy_consumption": 123,
        "engine_cc": 123,
        "engine_code": "<string>",
        "engine_configuration": "<string>",
        "engine_cycle": "<string>",
        "engine_litres": "<string>",
        "engine_type": "<string>",
        "external_reference": "<string>",
        "front_tyre_size": "<string>",
        "fuel_capacity": 123,
        "fuel_combined": 123,
        "fuel_country": 123,
        "fuel_delivery": "<string>",
        "fuel_metro": 123,
        "fuel_type_translation_id": "<string>",
        "gear_location": "<string>",
        "gears": 123,
        "good_retail_net": 123,
        "good_wholesale_net": 123,
        "greenhouse_rating": 123,
        "induction": "<string>",
        "kerb_weight": 123,
        "list_price_gross": 123,
        "list_price_gst": 123,
        "list_price_net": 123,
        "manufacturer_model_code": "<string>",
        "model_id": "<string>",
        "model_month": 123,
        "model_year": 123,
        "overall_green_star_rating": 123,
        "payload": 123,
        "power_kw": 123,
        "power_plant_type_id": "<string>",
        "power_rpm": 123,
        "private_maximum": 123,
        "private_minimum": 123,
        "rear_tyre_size": "<string>",
        "seats": 123,
        "series": "<string>",
        "service_kms": 123,
        "service_mths": 123,
        "service_profile_id": "<string>",
        "short_description": "<string>",
        "status_flag": "pending",
        "steering": "<string>",
        "torque": 123,
        "torque_rpm": 123,
        "towing_capacity": 123,
        "trade_maximum": 123,
        "trade_minimum": 123,

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

make_idstringquery

Optional Make Id

Maximum string length: 10

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

model_idstringquery

Optional Model Id

Maximum string length: 10

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

model_yearintegerquery

Optional Model Year

Required range: 1900 <= x <= 9999

variant_codestringquery

Optional Variant Code

This field supports the wildcard % operator.

Maximum string length: 25

Pattern: ^[a-zA-Z0-9\-\s\_\%]+$

variant_namestringquery

Optional Variant Name

This field supports the wildcard % operator.

Maximum string length: 50

Pattern: ^[a-zA-Z0-9\-\s\_\%]+$

body_type_idstringquery

Optional Body Type Id

Maximum string length: 10

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

data_source_idstringquery

Optional Data Source Id

Maximum string length: 10

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

profile_required_flagenum<string>querydefault:yes

If yes, display variants that have a qt_variant_profiles record with a 'date' valid for the current invocation date

Available options: yes, no

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive items required in the list

Available options: yes, no

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size.

Minimum value is 1. Maximum value is 100.

Required range: 1 <= x <= 100

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