Get photos for a specific variant
Get Photos for Specific Variant
Return photo URIs of selected variants.
Requires QuoteVariants:Get permission.
Go to Roles / APIs and check on QuoteVariants:Get.
HTTP Method
GET
Input - Header
Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.
Input - Body
URL Example
https://api.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine Successful Output
{ "_links": { "self": { "href": "https://api.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine&page=1" }, "first": { "href": "https://api.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine" }, "last": { "href": "https://api.catch-e.com/qt/variants/photos?variant_id=167353&photo_type=front,rear,interior,side,engine&page=1" } }, "_embedded": { "qt_variant_photos": [ { "photo_id": 283862, "variant_id": 167353, "photo_type": "front", "photo_uri": "https://demo.test.catch-e.net.au/core/services/Redbook/photos/AUS/S0005LLJ.jpg", "photo_code": "S0005LLJ", "description": "", "data_source_id": 100001 }, { "photo_id": 283863, "variant_id": 167353, "photo_type": "rear", "photo_uri": "https://demo.test.catch-e.net.au/core/services/Redbook/photos/AUS/S0005LLK.jpg", "photo_code": "S0005LLK", "description": "", "data_source_id": 100001 } ] }, "page_count": 1, "page_size": 25, "total_items": 2, "page": 1 } Error - 401 Unauthorized
"detail": "Unauthorized" Login token expired. Generate new token.
Error - 403 Forbidden
"detail": "Forbidden" You do not have permissions for this request.
Error - 422 Unprocessable Entity
Get Variant Optional Equipment by Variant ID
List all optional equipment for selected variant with status_flag of 'active'.
Requires QuoteVariants:Get permission.
Go to Roles / APIs and check on QuoteVariants:Get.
HTTP Method
GET
Input - Header
Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.
Input - Body
URL Example
https://api.catch-e.com/qt/variants/167353/optional-equipment?page=1&page_size=5 Successful Output
{ "_links": { "self": { "href": "https://api.catch-e.com/qt/variants/167353/optional-equipment?page=1" }, "first": { "href": "https://api.catch-e.com/qt/variants/167353/optional-equipment" }, "last": { "href": "https://api.catch-e.com/qt/variants/167353/optional-equipment?page=15" }, "next": { "href": "https://api.catch-e.com/qt/variants/167353/optional-equipment?page=2" } }, "_embedded": { "qt_variant_optional_equipment": [ { "optional_equipment_id": 109836, "variant_id": 167353, "supplier_id": 0, "list_price_net": 1181.82, "list_price_gst": 118.18, "cost_price_net": 1181.82, "option_type": "dealer", "dealer_fit": "yes", "include_by_default_flag": "no", "equipment_code": "", "description": "16\" Alloy Wheels", "fbt_exempt_flag": "no", "data_source_id": 100001 }, { "optional_equipment_id": 109837, "variant_id": 167353, "supplier_id": 0, "list_price_net": 1272.73, "list_price_gst": 127.27, "cost_price_net": 1272.73, "option_type": "dealer", "dealer_fit": "yes", "include_by_default_flag": "no", "equipment_code": "", "description": "17\" Alloy Wheels", "fbt_exempt_flag": "no", "data_source_id": 100001 }, { "optional_equipment_id": 109838, "variant_id": 167353, "supplier_id": 0, "list_price_net": 1636.36, "list_price_gst": 163.64, "cost_price_net": 1636.36, "option_type": "dealer", "dealer_fit": "yes", "include_by_default_flag": "no", "equipment_code": "", "description": "18\" Alloy Wheels", "fbt_exempt_flag": "no", "data_source_id": 100001 }, { "optional_equipment_id": 109839, "variant_id": 167353, "supplier_id": 0, "list_price_net": 1818.18, "list_price_gst": 181.82, "cost_price_net": 1818.18, "option_type": "dealer", "dealer_fit": "yes", "include_by_default_flag": "no", "equipment_code": "", "description": "19\" Alloy Wheels", "fbt_exempt_flag": "yes", "data_source_id": 100001 }, { "optional_equipment_id": 100000, "variant_id": 167353, "supplier_id": 0, "list_price_net": 0, "list_price_gst": 0, "cost_price_net": 0, "option_type": "dealer", "dealer_fit": "yes", "include_by_default_flag": "no", "equipment_code": "1ST", "description": "1st Aid Kit", "fbt_exempt_flag": "no", "data_source_id": 100000 } ] }, "page_count": 15, "page_size": 5, "total_items": 73, "page": 1 } Error - 401 Unauthorized
"detail": "Unauthorized" Login token expired. Generate new token.
Error - 403 Forbidden
"detail": "Forbidden" You do not have permissions for this request.
Error - 404 Not Found
"detail": null Entered variant_id cannot be found.
Get Variant Standard Equipment by Variant ID
List all standard equipment for selected variant.
Requires QuoteVariants:Get permission.
Go to Roles / APIs and check on QuoteVariants:Get.
HTTP Method
GET
Input - Header
Header should contain 'Accept' key with value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.
Input - Body
URL Example
https://api.catch-e.com/qt/variants/167353/standard-equipment?page=1&page_size=5 Successful Output
{ "_links": { "self": { "href": "https://api.catch-e.com/qt/variants/167353/standard-equipment?page=1" }, "first": { "href": "https://api.catch-e.com/qt/variants/167353/standard-equipment" }, "last": { "href": "https://api.catch-e.com/qt/variants/167353/standard-equipment?page=30" }, "next": { "href": "https://api.catch-e.com/qt/variants/167353/standard-equipment?page=2" } }, "_embedded": { "qt_variant_standard_equipment": [ { "standard_equipment_id": 131171, "description": "12V Socket(s) - Auxiliary" }, { "standard_equipment_id": 100142, "description": "18\" Alloy Wheels" }, { "standard_equipment_id": 100039, "description": "8 Speaker Stereo" }, { "standard_equipment_id": 100001, "description": "ABS (Antilock Brakes)" }, { "standard_equipment_id": 100511, "description": "Active Torque Transfer System" } ] }, "page_count": 30, "page_size": 5, "total_items": 148, "page": 1 } Error - 401 Unauthorized
"detail": "Unauthorized" Login token expired. Generate new token.
Error - 403 Forbidden
"detail": "Forbidden" You do not have permissions for this request.
Error - 404 Not Found
"detail": null Entered variant_id cannot be found.
Get List of Variant Profiles
Get list of Variant Profiles.
Requires QuoteVariants:Get permission.
Go to Roles / APIs and check on QuoteVariants:Get.
Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quote%20%2F%20Variants/getVariantProfiles
HTTP Method
GET
URL Examples
https://api.catch-e.com/qt/variant-profiles/ https://api.catch-e.com/qt/variant-profiles?variant_id=100000&page=1&page_size=5 Input - Body
Successful Output
{ "_links": { "self": { "href": "https://api.catch-e.com/qt/variant-profiles/?variant_id=100000&page=1" }, "first": { "href": "https://api.catch-e.com/qt/variant-profiles/?variant_id=100000" }, "last": { "href": "https://api.catch-e.com/qt/variant-profiles/?variant_id=100000&page=1" } }, "_embedded": { "items": [ { "variant_profile_id": "104693", "variant_id": "100000", "maintenance_service_profile_id": "100000", "tyre_id": "100523", "tyres_per_set": 4, "tyre_km_interval": 40000, "vehicle_type_id": "100001", "date": "2007-01-21", "delivery_metro": 600, "delivery_country": 800, "residual_adjustment_rate": 0, "insurance_type_id": "100001", "relief_vehicle": 10, "_links": { "self": { "href": "https://api.catch-e.com/qt/variant-profiles/104693" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 } Import Glass Data
Import Glass vehicle data with protected fields, audit trail, and validation.
Protected Fields
When new file would update existing fields back to zero or blank, those updates skipped to preserve populated data.
Protected fields:
weight
payload
towing_capacity
kerb_weight
fuel_metro
fuel_country
fuel_combined
warranty_years
warranty_kms
service_kms
service_mths
Preserve Data in Custom Fields
Nominate specific fields where data preserved and changes ignored. Data populated only if target fields currently zero or blank.
Use to keep specific data and ignore values imported by Glass. Contact Catch-e to nominate fields for this rule.
Audit Records
Records created/changed recorded in gb_audit_import. Run reports and queries over this table using timestamp of each import to identify new records and updates.
Contact Catch-e for sample queries:
Variants created and updated
Variant residuals updated
Other tables updated
Validation
Import process validates NVIC code for each row in each file. NVIC codes must be 6 characters. If any NVIC fields not 6 characters long, file fails and no vehicles imported. Catch-e support notified.
Required Files in Glass Archive
File Type Key
CVG: Commercial Vehicles (up to 10 years old, 4WDs and vans, load capacity less than 3510kg)
PVG: Passenger Vehicles (up to 10 years old inclusive)
HCV: Heavy/Commercial Vehicles
N12: New vehicles and prices released current year with NVIC, no alphanumeric prices
U12: All vehicles with second-hand prices, no alphanumeric prices, contains NVIC
Service 11 files with .U12 contain used vehicle values. Service 14 files with .U12 do not. Default: import Service 11 .U12 data when both present.
Same rules apply to PVG, HCV, CVG. OCG and OLC prefixes not used.
Suffix examples shown for CVG. Same suite required for PVG and HCV if included in feed. Example: subscribe all three datasets requires CVG11xxx.N12, PVG11xxx.N12, HCV11xxx.N12 etc.