Skip to main content
Quote / Variants

getVariantOptionalEquipment

getVariantOptionalEquipment

Overview

This method will list all optional equipment for selected variant with a status_flag of 'active'.

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:Get

HTTP Method

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

Input Fields (Header)

  • Header should contain the 'Accept' Key with the Value = 'application/json' or 'application/vnd.catch-e-api.v1+json'.

Input Fields (Body)

Field

Format

Notes

Mandatory

variant_id

string

Variant id

Yes

page

string

Page number. Defaults to 1

No

page_size

string

Page size. Defaults to 25 records per page.

No

Input URL Examples

https://api.test.catch-e.com/qt/variants/167353/optional-equipment?page=1&page_size=5 

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/qt/variants/167353/optional-equipment?page=1" }, "first": { "href": "https://api.test.catch-e.com/qt/variants/167353/optional-equipment" }, "last": { "href": "https://api.test.catch-e.com/qt/variants/167353/optional-equipment?page=15" }, "next": { "href": "https://api.test.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 Codes

Detail

Comments

401 - Unauthorized

"detail": "Unauthorized"

Login token has expired. You need to generate new token.

403 - Forbidden

"detail": "Forbidden"

You do not have permissions for this request.

404 - Not Found

"detail": null

Entered variant_id cannot be found.