Create Quote Endpoints: CreateVariants

CreateVariants

This method creates a a Variant and Variant Profile (optional).
.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Variants/createVariants(https://api.catch-e.com/docs/#/Quote%20%2F%20Variants/createVariants)

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on QuoteVariants:Create

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.catch-e.com/qt/variants

Headers

Body (JSON)

Input Fields (JSON)

[ { "model_id": "string", "model_year": 0, "variant_code": "string", "model_month": 0, "build_year": 0, "description": "string", "short_description": "string", "series": "string", "service_profile_id": "string", "vehicle_type_id": "string", "body_type_id": "string", "configuration": "string", "variant_name": "string", "variant_sub_name": "string", "transmission": "string", "gears": 0, "gear_location": "string", "doors": 0, "seats": 0, "engine_cc": 0, "engine_litres": "string", "cylinders": 0, "valves_per_cylinder": 0, "drive_type": "string", "engine_cycle": "string", "engine_type": "string", "engine_configuration": "string", "fuel_delivery": "string", "cam": "string", "steering": "string", "induction": "string", "fuel_type_translation_id": "string", "power_kw": 0, "power_rpm": 0, "torque": 0, "torque_rpm": 0, "wheel_base": 0, "weight": 0, "payload": 0, "towing_capacity": 0, "kerb_weight": 0, "country": "string", "fuel_capacity": 0, "front_tyre_size": "string", "rear_tyre_size": "string", "engine_code": "string", "power_plant_type_id": "string", "manufacturer_model_code": "string", "acceleration": 0, "fuel_metro": 0, "fuel_country": 0, "fuel_combined": 0, "co2_emissions": 0, "warranty_years": 0, "warranty_kms": 0, "service_kms": 0, "service_mths": 0, "list_price_gross": 0, "list_price_net": 0, "list_price_gst": 0, "average_wholesale_net": 0, "average_retail_net": 0, "good_wholesale_net": 0, "good_retail_net": 0, "greenhouse_rating": 0, "air_pollution_rating": 0, "overall_green_star_rating": 0, "ancap_rating": 0, "vfacts_class": "string", "vfacts_segment": "string", "current_vehicle_flag": "N", "variant_code_previous": "string", "variant_code_next": "string", "variant_profile": { "maintenance_service_profile_id": "string", "tyre_id": "string", "tyres_per_set": 0, "tyre_km_interval": 0, "vehicle_type_id": "string", "date": "2023-04-20", "delivery_metro": 0, "delivery_country": 0, "residual_adjustment_rate": 0, "insurance_type_id": "string", "relief_vehicle": 0 }, "external_reference": "string", "data_source_id": "string", "status_flag": "pending" }]

Response Details

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/" } }, "_embedded": { "qt_variants": [ { "acceleration": 5.7, "air_pollution_rating": 6.1, "ancap_rating": 5, "average_retail_net": 50000.77, "average_wholesale_net": 40000.77, "body_type_id": "100006", "build_year": 1980, "cam": "DOHC", "co2_emissions": 177, "configuration": "Config", "country": "Aussie", "current_vehicle_flag": "Y", "cylinders": 8, "data_source_id": "100000", "description": "Another oldie but a good vehicle nonetheless 1980", "doors": 5, "drive_type": "Rear Wheel Drive", "engine_cc": 2777, "engine_code": "ENGINECODE", "engine_configuration": "in-line", "engine_cycle": "MP1970V01", "engine_litres": "7", "engine_type": "Piston", "external_reference": "ExtReference", "front_tyre_size": "235/60 R22", "fuel_capacity": 77, "fuel_combined": 9.1, "fuel_country": 8.1, "fuel_delivery": "MPI", "fuel_metro": 10.1, "fuel_type_translation_id": "100033", "gear_location": "Floor", "gears": 8, "good_retail_net": 55000.77, "good_wholesale_net": 45000.77, "greenhouse_rating": 5.1, "induction": "Aspirated", "kerb_weight": 2377, "list_price_gross": 77770.77, "list_price_gst": 7770.08, "list_price_net": 69930.69, "manufacturer_model_code": "MPTST1970", "model_id": "100569", "model_month": 12, "model_year": 1980, "overall_green_star_rating": 7.1, "payload": 477, "power_kw": 444, "power_plant_type_id": "11989672791877091928", "power_rpm": 4444, "private_maximum": 0, "private_minimum": 0, "rear_tyre_size": "235/60 R22", "seats": 5, "series": "Two", "service_kms": 15000, "service_mths": 12, "service_profile_id": "0", "short_description": "An oldie but a goody 1980", "status_flag": "active", "steering": "Rack & Pinion", "torque": 277, "torque_rpm": 4777, "towing_capacity": 3577, "trade_maximum": 0, "transmission": "Automatic", "valves_per_cylinder": 4, "variant_code": "MPAU1980APIVARIANT1", "variant_code_next": "", "variant_code_previous": "", "variant_id": "182511", "variant_name": "GoGo Gone", "variant_profiles": { "variant_profile_id": "181180", "variant_id": "182511", "maintenance_service_profile_id": "100012", "tyre_id": "100001", "tyres_per_set": 4, "tyre_km_interval": 45001, "vehicle_type_id": "100001", "date": "1971-01-01", "delivery_metro": 777.77, "delivery_country": 888.88, "residual_adjustment_rate": 0.5, "insurance_type_id": "100004", "relief_vehicle": 0 }, "variant_sub_name": "Fasterer", "vehicle_type_id": "100001", "vfacts_class": "Medium", "vfacts_segment": "Medium2", "warranty_kms": 200000, "warranty_years": 5, "weight": 1077, "wheel_base": 2777, "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/182511" } } } ] }, "total_items": 1}

| A successful response returns all fields in the and tables. |
| 422 Unprocessable Entity | | |

{ "validation_messages": [ { "variant_code": { "recordFound": "A record matching the input was found" } } ], "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

| It looks like this Variant Code already exists. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |