Developer Docs
Index
Technical Changelog
Version 1.0.6

API Doc Version 1.0.6

What's New

GET /config/status-flags/{status_flag_id}

Get status flag by Id

GET /config/status-flags

Gets all status flag

POST /config/status-flags

Creates a status flag

DELETE /config/status-flags/{status_flags_id}

Deletes a status flag record

PATCH /config/status-flags/{status_flags_id}

Updates a status flag record

GET /config/dairy-category/{dairy_category_id}

Get Dairy Category by Id

DELETE /config/dairy-category/{dairy_category_id}

Deletes a Dairy Category record

PATCH /config/dairy-category/{dairy_category_id}

Updates a Dairy Category record

GET /config/dairy-category

Gets all Dairy Category

POST /config/dairy-category

Creates a Diary Category

POST /config/checklist_evaluate/

evalute checklist responses

POST /config/get_event_associated_checklist/

returns checklist against given event and criteria

POST /config/create_event_association/

configure event association

PATCH /config/update_checklist/

updates checklist

DELETE /config/delete_checklist_by_name/{checklist_name}

remove checklist by name

GET /config/get_all_checklist

gets all active checklists by name

GET /config/get_checklist_by_name/{checklist_name}

gets a single checklist by name

POST /config/create_checklist/

create checklist

What's Deleted

POST /config/integration/create-json

Create json data

GET /config/integration/json_data

Get all json records

GET /config/integration/json_data/{json_data_key}

Get json record by key

What's Changed

GET /config/vehicle

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/vehicle-detail

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/asset-model

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

POST /config/asset-model

Request:

Changed content type : application/json

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_image (string -> array)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

GET /config/asset-model/{asset_model_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

DELETE /config/asset-model/{asset_model_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

GET /config/asset-model/by-asset-make-id/{asset_make_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

PATCH /config/asset-model/{model_id}

Request:

Changed content type : application/json

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_image (string -> array)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

GET /config/asset-trim

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property trim_image (string -> array)

POST /config/asset-trim

Request:

Changed content type : application/json

  • Changed property trim_image (string -> array)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property trim_image (string -> array)

GET /config/asset-trim/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

GET /config/asset-trim/{trim_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property trim_image (string -> array)

DELETE /config/asset-trim/{trim_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property trim_image (string -> array)

PATCH /config/asset-trim/{trim_id}

Request:

Changed content type : application/json

  • Changed property trim_image (string -> array)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property trim_image (string -> array)

GET /config/asset-model-trim

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

PATCH /config/asset-conditions/{asset_condition_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property trim_image (string -> array)

POST /config/lender

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/financial-product

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property dealerships (array)

      Associated dealers with a program

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

DELETE /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

PATCH /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

POST /config/financial-product/create-fp

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

PATCH /config/financial-product/update-fp/{custom_financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

PATCH /config/credit-ratings/{credit_rating_id}

Parameters:

Added: lender_id in header

GET /config/master-list-accessories

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New required properties:

    • image

    • Changed property compatible_models (array)

      Compatible models of Master List Accessory

      Changed items (integer -> object):

    • Changed property image (string -> array)

      Image of Master List Accessory

POST /config/master-list-accessories

Request:

Changed content type : application/json

New required properties:

  • image

New optional properties:

  • compatible_models

  • Added property is_deleted (boolean)

  • Changed property image (string -> array)

    Image of Master List Accessory

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New required properties:

    • image

    • Changed property compatible_models (array)

      Compatible models of Master List Accessory

      Changed items (integer -> object):

    • Changed property image (string -> array)

      Image of Master List Accessory

GET /config/master-list-accessorie/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      New required properties:

      • image

      • Changed property compatible_models (array)

        Compatible models of Master List Accessory

        Changed items (integer -> object):

      • Changed property image (string -> array)

        Image of Master List Accessory

GET /config/master-list-accessories/{masteraccessory_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New required properties:

    • image

    New optional properties:

    • compatible_models

    • Added property is_deleted (boolean)

    • Changed property image (string -> array)

      Image of Master List Accessory

DELETE /config/master-list-accessories/{masteraccessory_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New required properties:

    • image

    New optional properties:

    • compatible_models

    • Added property is_deleted (boolean)

    • Changed property image (string -> array)

      Image of Master List Accessory

PATCH /config/master-list-accessories/{masteraccessory_id}

Request:

Changed content type : application/json

New required properties:

  • image

New optional properties:

  • compatible_models

  • Added property is_deleted (boolean)

  • Changed property image (string -> array)

    Image of Master List Accessory

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New required properties:

    • image

    • Changed property compatible_models (array)

      Compatible models of Master List Accessory

      Changed items (integer -> object):

    • Changed property image (string -> array)

      Image of Master List Accessory

POST /config/contract-term/create-contract-term

Request:

Changed content type : application/json

  • Added property is_deleted (boolean)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_deleted (boolean)

GET /config/contract-term/{contract_term_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_deleted (boolean)

DELETE /config/contract-term/{contract_term_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_deleted (boolean)

PATCH /config/contract-term/{contract_term_id}

Request:

Changed content type : application/json

  • Added property is_deleted (boolean)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_deleted (boolean)

GET /config/contract-term/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property is_deleted (boolean)

GET /config/contract-term/active

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property is_deleted (boolean)

GET /config/contract-term

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property is_deleted (boolean)

GET /config/stipulation/

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New optional properties:

    • lender_id

POST /config/stipulation/

Request:

Changed content type : application/json

New optional properties:

  • lender_id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • lender_id

GET /config/stipulation/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      New optional properties:

      • lender_id

GET /config/stipulation/{stipulation_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • lender_id

DELETE /config/stipulation/{stipulation_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • lender_id

PATCH /config/stipulation/{stipulation_id}

Request:

Changed content type : application/json

New optional properties:

  • lender_id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • lender_id

GET /config/dealer/option

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New optional properties:

    • compatible_models

    • Changed property image (string -> array)

      AddonModel image

    • Changed property compatible_models (array)

      AddonModel compatible_models

      Changed items (object):

      • Changed property trim_image (string -> array)

POST /config/dealer/option

Request:

Changed content type : application/json

  • Changed property image (string -> array)

    AddonModel image

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    New optional properties:

    • compatible_models

    • dealer_id

    • lender_id

    • Changed property compatible_models (array)

      AddonModel compatible_models

      Changed items (integer -> object):

    • Changed property image (string -> array)

      AddonModel image

GET /config/dealer/option-trim-code

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property image (string -> array)

      AddonModel image

GET /config/dealer/option/{option_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property image (string -> array)

      AddonModel image

DELETE /config/dealer/option/{option_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property image (string -> array)

      AddonModel image

PATCH /config/dealer/option/{option_id}

Request:

Changed content type : application/json

  • Changed property image (string -> array)

    AddonModel image

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • compatible_models

    • dealer_id

    • lender_id

    • Changed property compatible_models (array)

      AddonModel compatible_models

      Changed items (integer -> object):

    • Changed property image (string -> array)

      AddonModel image

GET /config/dealer/fee/dealer-id/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/dealer/tradein

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property lender_id (integer)

      DealerTradeIn lender id

POST /config/dealer/tradein

Request:

Changed content type : application/json

  • Added property lender_id (integer)

    DealerTradeIn lender id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property lender_id (integer)

      DealerTradeIn lender id

GET /config/dealer/tradein-by-dealer-id/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property lender_id (integer)

      DealerTradeIn lender id

GET /config/dealer/tradein/{trade_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property lender_id (integer)

      DealerTradeIn lender id

DELETE /config/dealer/tradein/{trade_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property lender_id (integer)

      DealerTradeIn lender id

PATCH /config/dealer/tradein/{dealer_id}

Request:

Changed content type : application/json

  • Added property lender_id (integer)

    DealerTradeIn lender id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property lender_id (integer)

      DealerTradeIn lender id

PUT /config/dealerships/{dealership_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/vehicle_by_vin/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/vehicle/{vin}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /config/vehicle/

Request:

Changed content type : application/json

New optional properties:

  • engine_power
  • fax
  • Changed property type (integer -> string)

    Type of vehicle

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

DELETE /config/vehicle/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • engine_power

    • fax

    • Changed property type (integer -> string)

      Type of vehicle

PATCH /config/vehicle/{vehicle_id}

Request:

Changed content type : application/json

New optional properties:

  • engine_power
  • fax
  • Changed property type (integer -> string)

    Type of vehicle

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • engine_power

    • fax

    • Changed property type (integer -> string)

      Type of vehicle

GET /config/vehicle-detail/{vin}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/inventory/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /config/vehicle-detail/

Request:

Changed content type : application/json

  • Added property lender_id (integer)

    Lender_id of vehicle

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property lender_id (integer)

      Lender_id of vehicle

PATCH /config/vehicle-detail/{vehicle_detail_id}

Request:

Changed content type : application/json

  • Added property lender_id (integer)

    Lender_id of vehicle

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

DELETE /config/vehicle-detail/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/inventory/reference-data-by-dealer-code/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/inventory/attached-option

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/financial-insurance

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property image (string -> array)

      List of images for Financial Insurance Product

POST /config/financial-insurance

Request:

Changed content type : application/json

  • Changed property image (string -> array)

    List of images for Financial Insurance Product

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Changed property image (string -> array)

      List of images for Financial Insurance Product

GET /config/financial-insurance/{financial_insurance_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property image (string -> array)

      List of images for Financial Insurance Product

DELETE /config/financial-insurance/{financial_insurance_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property image (string -> array)

      List of images for Financial Insurance Product

PATCH /config/financial-insurance/{financial_insurance_id}

Request:

Changed content type : application/json

  • Changed property image (string -> array)

    List of images for Financial Insurance Product

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property image (string -> array)

      List of images for Financial Insurance Product

GET /config/integrations/lender/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/integration/dealer/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/integrations/dealer/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /config/bucket/upload-file

GET /config/asset-make

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property asset_models (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

POST /config/asset-make

Request:

Changed content type : application/json

  • Changed property asset_models (array)

    Changed items (object):

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

GET /config/asset-make/test/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property asset_models (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

GET /config/all-asset-make

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property asset_models (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

GET /config/asset-make/{make_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_models (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

DELETE /config/asset-make/{make_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_models (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

PATCH /config/asset-make/{make_id}

Request:

Changed content type : application/json

  • Changed property asset_models (array)

    Changed items (object):

    • Changed property asset_trims (array)

      Changed items (object):

      • Changed property trim_image (string -> array)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property asset_models (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

GET /config/asset-model/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property asset_trims (array)

        Changed items (object):

        • Changed property trim_image (string -> array)

GET /config/financial-product/filter

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property dealerships (array)

        Associated dealers with a program

GET /config/dealer/option/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      New optional properties:

      • compatible_models

      • Changed property image (string -> array)

        AddonModel image

      • Changed property compatible_models (array)

        AddonModel compatible_models

        Changed items (object):

        • Changed property trim_image (string -> array)

POST /config/dealer/configurations

Request:

Changed content type : application/json

  • Changed property tradein (object)

    • Added property lender_id (integer)

      DealerTradeIn lender id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

GET /config/financial-insurances/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property image (string -> array)

        List of images for Financial Insurance Product

GET /config/asset-make/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property asset_models (array)

        Changed items (object):

        • Changed property asset_trims (array)

          Changed items (object):

          • Changed property trim_image (string -> array)

GET /config/asset-data/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property asset_models (array)

        Changed items (object):

        • Changed property asset_trims (array)

          Changed items (object):

          • Changed property trim_image (string -> array)
Version 1.0.7Version 1.0.5