Quote / Variants

Create variants

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

POST

/qt/variants

Create variants

curl --request POST \
  --url https://api.catch-e.com/qt/variants \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Time-Zone: UTC' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "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,
    "transmission": "<string>",
    "valves_per_cylinder": 123,
    "variant_code": "<string>",
    "variant_code_next": "<string>",
    "variant_code_previous": "<string>",
    "variant_name": "<string>",
    "variant_paints": {
      "data_source_id": "<string>",
      "description": "<string>",
      "generic_colour": "<string>",
      "paint_type": "<string>"
    },
    "variant_profile": {
      "date": "2023-12-25",
      "delivery_country": 123,
      "delivery_metro": 123,
      "insurance_type_id": "<string>",
      "maintenance_service_profile_id": "<string>",
      "relief_vehicle": 123,
      "residual_adjustment_rate": 123,
      "tyre_id": "<string>",
      "tyre_km_interval": 123,
      "tyres_per_set": 123,
      "vehicle_type_id": "<string>"
    },
    "variant_sub_name": "<string>",
    "vehicle_type_id": "<string>",
    "vfacts_class": "<string>",
    "vfacts_segment": "<string>",
    "warranty_kms": 123,
    "warranty_years": 123,
    "weight": 123,
    "wheel_base": 123
  }
]
'

{
  "_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

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

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

Time-Zonestringheaderdefault:UTC

Variants will be processed in the specified timezone.

The timezone value can be given in several formats, none of which are case sensitive:

As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'.
As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;

Maximum string length: 100

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

Body

JSON payload

itemsobject[]

Show child attributes

Response

Variant(s) created successfully

_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