Developer Docs
Index
Technical Changelog
Version 1.0.8

API Doc Version 1.0.8

What's New

PATCH /config/lender/update-lender/{lenders_id}

Updates a lender record

GET /config/get_api_key/{token}

Get Api Key

GET /config/prefix

Gets all prefix

POST /config/prefix

Creates a prefix

GET /config/prefix/{prefix_identifier}

Get prefix by Identifier

DELETE /config/prefix/{prefix_identifier}

Deletes a prefix record

PATCH /config/prefix/{prefix_identifier}

Updates a prefix record

GET /config/address-category

Gets all address category

GET /config/address_category/{address_category_identifier}

Get address category by Identifier

DELETE /config/address_category/{address_category_identifier}

Deletes a address category record

PATCH /config/address_category/{address_category_identifier}

Updates a address category record

POST /config/address_category

Creates a address category

GET /config/event

Gets all events

POST /config/event

Creates an event record

GET /config/event/{event_id}

Get event type by Id

DELETE /config/event/{event_id}

Deletes an event record

PATCH /config/event/{event_id}

Updates an event record

GET /config/reason

Gets all reasons

POST /config/reason

Creates a reason

GET /config/reason/{reason_id}

Get reason by Id

DELETE /config/reason/{reason_id}

Deletes a reason

PATCH /config/reason/{reason_id}

Updates a reason

GET /config/odometer/{lender_id}

Get odometer variance threshold value by Id

GET /config/dealerships/find/by-tenant

Get dealership record provided by Id

GET /config/dealer/find/by-tenant

Get dealer by Tenant ID and Email

GET /config/inventory/attached-option/filter

Get all attached option accessories

PATCH /config/integration/lender/status/{lender_integration_id}

Updates lender integration

DELETE /config/delete_event_criteria_association/{criteria_identifier}

This API helps to delete existing criteria based on identifier.

What's Deleted

GET /config/get_checklist_association_by_name/{checklist_name}

gets a checklist event criteria association

What's Changed

GET /config/health

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/get_all_checklist

This API helps to retreive active checklist and event criteria associated with them.

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/currencies

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/state

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/accessories-category

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/vehicle

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New optional properties:

    • address

    • body_style

    • body_type

    • city

    • dealer_location_id

    • dealer_url

    • doing_business_as

    • doors

    • drive_train

    • engine

    • engine_cylinders

    • engine_description

    • exterior_color_description

    • exterior_color_manufacturer_code

    • interior_color_description

    • interior_color_manufacturer_code

    • non_package_option_codes

    • non_package_option_descriptions

    • phone_number

    • photo_urls

    • price_2

    • state

    • stock_number

    • transmission_type

    • vehicle_comments

    • vehicle_display_name

    • vehicle_url

    • zip

    • Changed property vehicle_url (string -> object)

      List of vehicle URLs

    • Changed property photo_urls (string -> object)

      List of vehicle photo urls

GET /config/vehicle-detail

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/countries

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/asset-list-import/

Parameters:

Deleted: db_engine in query

GET /config/asset-group/

Parameters:

Deleted: db_engine in query

POST /config/asset-group/

Parameters:

Deleted: db_engine in query

GET /config/asset-group/{asset_group_id}

Parameters:

Deleted: db_engine in query

DELETE /config/asset-group/{asset_group_id}

Parameters:

Deleted: db_engine in query

PATCH /config/asset-group/{asset_group_id}

Parameters:

Deleted: db_engine in query

GET /config/asset-make/make_code/{make_code}

Parameters:

Deleted: db_engine in query

GET /config/asset-model

Parameters:

Deleted: db_engine in query

POST /config/asset-model

Parameters:

Deleted: db_engine in query

GET /config/asset-model/{asset_model_id}

Parameters:

Deleted: db_engine in query

DELETE /config/asset-model/{asset_model_id}

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

PATCH /config/asset-model/{model_id}

Parameters:

Deleted: db_engine in query

GET /config/asset-model/model_code/{model_code}

Parameters:

Deleted: db_engine in query

GET /config/asset-trim

Parameters:

Deleted: db_engine in query

POST /config/asset-trim

Parameters:

Deleted: db_engine in query

GET /config/asset-trim/filter

Parameters:

Deleted: db_engine in query

GET /config/asset-trim/{trim_id}

Parameters:

Deleted: db_engine in query

DELETE /config/asset-trim/{trim_id}

Parameters:

Deleted: db_engine in query

PATCH /config/asset-trim/{trim_id}

Parameters:

Deleted: db_engine in query

GET /config/asset-model-trim

Parameters:

Deleted: db_engine in query

GET /config/asset-trim/trim_code/{trim_code}

Parameters:

Deleted: db_engine in query

GET /config/asset-condition-test/filter

Parameters:

Deleted: db_engine in query

GET /config/asset-conditions

Parameters:

Deleted: db_engine in query

POST /config/asset-conditions

Parameters:

Deleted: db_engine in query

GET /config/asset-conditions/{asset_condition_id}

Parameters:

Deleted: db_engine in query

DELETE /config/asset-conditions/{asset_condition_id}

Parameters:

Deleted: db_engine in query

PATCH /config/asset-conditions/{asset_condition_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New required properties:

    • code

    • description

    • is_active

    • Added property code (string)

    • Added property description (string)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

GET /config/asset-condition/active

Parameters:

Deleted: db_engine in query

GET /config/asset-conditions/code/{code}

Parameters:

Deleted: db_engine in query

POST /config/lender/create-lender

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

  • Changed property lender_profile (object)

    • Added property odometer_variance (integer)

      Odometer variance threshold configuration

    • Added property key_id (integer)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property odometer_variance (integer)

      Odometer variance threshold configuration

    • Added property key_id (integer)

GET /config/lender

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/lender

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

New required properties:

  • key_id
  • Added property key_id (integer)

    Key id for lender creation

GET /config/lender/{lender_id}

Parameters:

Deleted: db_engine in query

PATCH /config/lender/{lender_id}

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

  • Changed property lender_profile (object)

    • Added property odometer_variance (integer)

      Odometer variance threshold configuration

    • Added property key_id (integer)

DELETE /config/lender/{id}

Parameters:

Added: lender_id in query

Deleted: id in path

Deleted: db_engine in query

GET /config/lender/by-tenant-id/{tenant_id}

Parameters:

Deleted: db_engine in query

DELETE /config/address/{address_id}

Parameters:

Deleted: db_engine in query

GET /config/charts

Parameters:

Deleted: db_engine in query

POST /config/charts

Parameters:

Deleted: db_engine in query

GET /config/interest-chart/filter

Parameters:

Deleted: db_engine in query

GET /config/charts/{chart_id}

Parameters:

Deleted: db_engine in query

DELETE /config/charts/{chart_id}

Parameters:

Deleted: db_engine in query

PATCH /config/charts/{chart_id}

Parameters:

Deleted: db_engine in query

GET /config/interest-chart

Parameters:

Deleted: db_engine in query

POST /config/interest-chart

Parameters:

Deleted: db_engine in query

GET /config/interest-chart/{interest_chart_id}

Parameters:

Deleted: db_engine in query

DELETE /config/interest-chart/{interest_chart_id}

Parameters:

Deleted: db_engine in query

PATCH /config/interest-chart/{interest_chart_id}

Parameters:

Deleted: db_engine in query

GET /config/rv-chart

Parameters:

Deleted: db_engine in query

POST /config/rv-chart

Parameters:

Deleted: db_engine in query

GET /config/rv-chart/filter

Parameters:

Deleted: db_engine in query

GET /config/rv-chart/{rv_chart_id}

Parameters:

Deleted: db_engine in query

DELETE /config/rv-chart/{rv_chart_id}

Parameters:

Deleted: db_engine in query

PATCH /config/rv-chart/{rv_chart_id}

Parameters:

Deleted: db_engine in query

GET /config/chart-association/

Parameters:

Deleted: db_engine in query

POST /config/chart-association/

Parameters:

Deleted: db_engine in query

GET /config/chart-association/{charts_association_id}

Parameters:

Deleted: db_engine in query

DELETE /config/chart-association/{charts_association_id}

Parameters:

Deleted: db_engine in query

PATCH /config/chart-association/{charts_association_id}

Parameters:

Deleted: db_engine in query

POST /config/rv-evaluate

Parameters:

Deleted: db_engine in query

POST /config/interest-chart-evaluate

Parameters:

Deleted: db_engine in query

POST /config/interest-chart/criteria

Parameters:

Deleted: db_engine in query

POST /config/rv-chart/criteria

Parameters:

Deleted: db_engine in query

GET /config/interest-charts/name

Parameters:

Deleted: db_engine in query

GET /config/rv-charts/name

Parameters:

Deleted: db_engine in query

GET /config/financial-product

Parameters:

Deleted: db_engine in query

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

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

POST /config/financial-product

Parameters:

Deleted: db_engine in query

GET /config/financial-product/{financial_product_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

DELETE /config/financial-product/{financial_product_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

PATCH /config/financial-product/{financial_product_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

POST /config/financial-product/create-fp

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

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

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property dealerships (array)

      Associated dealers with a program

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

GET /config/financial-parameter/

Parameters:

Deleted: db_engine in query

POST /config/financial-parameter/

Parameters:

Deleted: db_engine in query

GET /config/financial-parameter/{financial_parameter_id}

Parameters:

Deleted: db_engine in query

DELETE /config/financial-parameter/{financial_parameter_id}

Parameters:

Deleted: db_engine in query

PATCH /config/financial-parameter/{financial_parameter_id}

Parameters:

Deleted: db_engine in query

GET /config/financial-product/name/{name}

Parameters:

Deleted: db_engine in query

GET /config/financial-product/code/{code}

Parameters:

Deleted: db_engine in query

GET /config/document-type

Parameters:

Deleted: db_engine in query

POST /config/document-type

Parameters:

Deleted: db_engine in query

GET /config/document-type/filter

Parameters:

Deleted: db_engine in query

GET /config/document-type/{document_type_id}

Parameters:

Deleted: db_engine in query

DELETE /config/document-type/{document_type_id}

Parameters:

Deleted: db_engine in query

PATCH /config/document-type/{document_type_id}

Parameters:

Deleted: db_engine in query

GET /config/allowed-mileage

Parameters:

Deleted: db_engine in query

GET /config/allowed-mileage/{mileage_id}

Parameters:

Deleted: db_engine in query

GET /config/terms

Parameters:

Deleted: db_engine in query

POST /config/terms

Parameters:

Deleted: db_engine in query

GET /config/term/active

Parameters:

Deleted: db_engine in query

GET /config/terms/{term_id}

Parameters:

Deleted: db_engine in query

DELETE /config/terms/{term_id}

Parameters:

Deleted: db_engine in query

Changed: term_id in path

PATCH /config/terms/{term_id}

Parameters:

Deleted: db_engine in query

GET /config/term/filter

Parameters:

Deleted: db_engine in query

GET /config/credit-ratings

Parameters:

Deleted: db_engine in query

POST /config/credit-ratings

Parameters:

Deleted: db_engine in query

GET /config/credit-ratings/filter

Parameters:

Deleted: db_engine in query

GET /config/credit-rating/active

Parameters:

Deleted: db_engine in query

GET /config/credit-ratings/{credit_rating_id}

Parameters:

Deleted: db_engine in query

DELETE /config/credit-ratings/{credit_rating_id}

Parameters:

Deleted: db_engine in query

Changed: credit_rating_id in path

PATCH /config/credit-ratings/{credit_rating_id}

Parameters:

Deleted: db_engine in query

GET /config/annual-mileage

Parameters:

Deleted: db_engine in query

POST /config/annual-mileage

Parameters:

Deleted: db_engine in query

GET /config/annual-mileage/filter

Parameters:

Deleted: db_engine in query

GET /config/annual-mileage/active

Parameters:

Deleted: db_engine in query

GET /config/annual-mileage/{annual_mileage_id}

Parameters:

Deleted: db_engine in query

DELETE /config/annual-mileage/{annual_mileage_id}

Parameters:

Deleted: db_engine in query

PATCH /config/annual-mileage/{annual_mileage_id}

Parameters:

Deleted: db_engine in query

GET /config/fee-names

Parameters:

Deleted: db_engine in query

POST /config/fee-names

Parameters:

Deleted: db_engine in query

GET /config/fee-names/{fee_name_id}

Parameters:

Deleted: db_engine in query

DELETE /config/fee-names/{fee_name_id}

Parameters:

Deleted: db_engine in query

PATCH /config/fee-names/{fee_name_id}

Parameters:

Deleted: db_engine in query

GET /config/fee-name/filter

Parameters:

Deleted: db_engine in query

GET /config/master-list-accessories

Parameters:

Deleted: db_engine in query

POST /config/master-list-accessories

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/accessories-category/{accessory_id}

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/contract-term/{contract_term_id}

Parameters:

Deleted: db_engine in query

DELETE /config/contract-term/{contract_term_id}

Parameters:

Deleted: db_engine in query

PATCH /config/contract-term/{contract_term_id}

Parameters:

Deleted: db_engine in query

GET /config/contract-term/filter

Parameters:

Deleted: db_engine in query

GET /config/contract-term/active

Parameters:

Deleted: db_engine in query

GET /config/contract-term

Parameters:

Deleted: db_engine in query

GET /config/contract-allowed-annum-mileage/filter

Parameters:

Deleted: db_engine in query

GET /config/option-category

Parameters:

Deleted: db_engine in query

POST /config/option-category

Parameters:

Deleted: db_engine in query

GET /config/option-category/active

Parameters:

Deleted: db_engine in query

GET /config/option-category/{option_category_id}

Parameters:

Deleted: db_engine in query

DELETE /config/option-category/{option_category_id}

Parameters:

Deleted: db_engine in query

PATCH /config/option-category/{option_category_id}

Parameters:

Deleted: db_engine in query

GET /config/option-category/filter/

Parameters:

Deleted: db_engine in query

GET /config/contract-allowed-annum-mileage

Parameters:

Deleted: db_engine in query

POST /config/contract-allowed-annum-mileage

Parameters:

Deleted: db_engine in query

GET /config/contract-allowed-annum-mileage/{contract_allowed_annum_mileage_id}

Parameters:

Deleted: db_engine in query

DELETE /config/contract-allowed-annum-mileage/{contract_allowed_annum_mileage_id}

Parameters:

Deleted: db_engine in query

PATCH /config/contract-allowed-annum-mileage/{contract_allowed_annum_mileage_id}

Parameters:

Deleted: db_engine in query

GET /config/contract-allowed-annum-mileage/active

Parameters:

Deleted: db_engine in query

GET /config/decision_status

Parameters:

Deleted: db_engine in query

POST /config/decision_status

Parameters:

Deleted: db_engine in query

GET /config/decision_status/{decision_status_id}

Parameters:

Deleted: db_engine in query

DELETE /config/decision_status/{decision_status_id}

Parameters:

Deleted: db_engine in query

PATCH /config/decision_status/{decision_status_id}

Parameters:

Deleted: db_engine in query

GET /config/decision_statuses/filter

Parameters:

Deleted: db_engine in query

GET /config/status-flags/{status_flag_id}

Parameters:

Deleted: db_engine in query

GET /config/status-flags

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/status-flags

Parameters:

Deleted: db_engine in query

DELETE /config/status-flags/{status_flags_id}

Parameters:

Deleted: db_engine in query

PATCH /config/status-flags/{status_flags_id}

Parameters:

Deleted: db_engine in query

GET /config/dairy-category/{dairy_category_id}

Parameters:

Deleted: db_engine in query

DELETE /config/dairy-category/{dairy_category_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dairy-category/{dairy_category_id}

Parameters:

Deleted: db_engine in query

GET /config/dairy-category

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/dairy-category

Parameters:

Deleted: db_engine in query

GET /config/stipulation/

Parameters:

Deleted: db_engine in query

POST /config/stipulation/

Parameters:

Deleted: db_engine in query

GET /config/stipulation/filter

Parameters:

Deleted: db_engine in query

GET /config/stipulation/{stipulation_id}

Parameters:

Deleted: db_engine in query

DELETE /config/stipulation/{stipulation_id}

Parameters:

Deleted: db_engine in query

PATCH /config/stipulation/{stipulation_id}

Parameters:

Deleted: db_engine in query

POST /config/programs/all/

Parameters:

Deleted: db_engine in query

GET /config/dealer/option

Parameters:

Deleted: db_engine in query

POST /config/dealer/option

Parameters:

Deleted: db_engine in query

GET /config/dealer/option-trim-code

Parameters:

Deleted: db_engine in query

GET /config/dealer/option/{option_id}

Parameters:

Deleted: db_engine in query

DELETE /config/dealer/option/{option_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/option/{option_id}

Parameters:

Deleted: db_engine in query

GET /config/dealer/fee

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/dealer/fee

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/dealer/{dealer_id}/fees

Parameters:

Deleted: db_engine in query

GET /config/dealer/fee/{fee_id}

Parameters:

Deleted: db_engine in query

DELETE /config/dealer/fee/{fee_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/fee/{fee_id}

Parameters:

Deleted: db_engine in query

GET /config/dealer/profile

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/dealer/profile

Parameters:

Deleted: db_engine in query

DELETE /config/dealer/profile/{dealer_profile_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/profile/{dealer_profile_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/profile/pen-dealer-id/{dealer_profile_id}/{pen_dealer_id}

Parameters:

Deleted: db_engine in query

GET /config/dealer/profile/{dealer_id}

Parameters:

Deleted: db_engine in query

GET /config/dealer/preference

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/dealer/preference

Parameters:

Deleted: db_engine in query

DELETE /config/dealer/preference/{dealerpreference_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/preference/{dealer_preference_id}

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/dealer/payment-detail

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/dealer/payment-detail

Parameters:

Deleted: db_engine in query

GET /config/dealer/payment-detail/{payment_id}

Parameters:

Deleted: db_engine in query

DELETE /config/dealer/payment-detail/{payment_id}

Parameters:

Deleted: db_engine in query

GET /config/dealer/payment-detail_by_dealer_id/{dealer_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/payment-detail/{payment_detail_id}

Parameters:

Deleted: db_engine in query

GET /config/dealer/tradein

Parameters:

Deleted: db_engine in query

POST /config/dealer/tradein

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/dealer/tradein/{trade_id}

Parameters:

Deleted: db_engine in query

DELETE /config/dealer/tradein/{trade_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/tradein/{dealer_id}

Parameters:

Deleted: db_engine in query

POST /config/dealerships

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

  • Added property user_id (integer)

    DealershipModel dealer id

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property user_id (integer)

      DealershipModel dealer id

GET /config/dealerships/active

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New optional properties:

    • code

    • contact_person_email

    • contact_person_first_name

    • contact_person_role

    • is_active

    • Deleted property is_active (boolean)

      DealershipModel is active

    • Deleted property is_deleted (boolean)

    • Deleted property contact_person_first_name (string)

      DealershipModel contact person first name

    • Deleted property contact_person_last_name (string)

      DealershipModel contact person last name

    • Deleted property contact_person_email (string)

      DealershipModel contact person email

    • Deleted property contact_person_role (string)

      DealershipModel contact person role

    • Changed property code (string)

      DealershipModel dealer id

GET /config/dealerships/dealer_id/{dealer_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New required properties:

    • contact_person
    • dealer_code
    • dealer_name
    • digital_retail
    • email
    • is_default_password_changed
    • lender_id

    New optional properties:

    • code

    • contact_person_email

    • contact_person_first_name

    • contact_person_role

    • is_active

    • name

    • Added property dealer_name (string)

      Dealer Name for Dealer Creation

    • Added property dealer_code (string)

      Dealer Code For the Dealer

    • Added property contact_person (string)

      Contact Person for Dealer

    • Added property email (string)

      Email address of Dealer

    • Added property password (string)

      Password for created Dealer

    • Added property contact_number (string)

      Contact Number of Dealer

    • Added property digital_retail (boolean)

      Digital Retail required or not for Dealer

    • Added property website (string)

      Website of Dealer

    • Added property zip_code (string)

      Zip Code of Dealer City

    • Added property is_default_password_changed (boolean)

      IsDefault Password changed or not after dealer creation

    • Added property dealership_id (integer)

      dealership_id

    • Deleted property is_active (boolean)

      DealershipModel is active

    • Deleted property is_deleted (boolean)

    • Deleted property name (string)

      DealershipModel name

    • Deleted property code (string)

      DealershipModel code

    • Deleted property contact_person_first_name (string)

      DealershipModel contact person first name

    • Deleted property contact_person_last_name (string)

      DealershipModel contact person last name

    • Deleted property contact_person_email (string)

      DealershipModel contact person email

    • Deleted property contact_person_role (string)

      DealershipModel contact person role

    • Deleted property dealer_id (integer)

      DealershipModel dealer id

    • Changed property id (integer)

      Dealer Id

    • Changed property lender_id (integer)

      lender Id against which dealer is created

GET /config/dealerships/filter

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property user_id (integer)

        DealershipModel dealer id

GET /config/dealerships/{dealership_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property user_id (integer)

      DealershipModel dealer id

PUT /config/dealerships/{dealership_id}

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

  • Added property user_id (integer)

    DealershipModel dealer id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property user_id (integer)

      DealershipModel dealer id

DELETE /config/dealerships/{dealership_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property user_id (integer)

      DealershipModel dealer id

GET /config/dealer

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New optional properties:

    • contact_number

    • password

    • website

    • zip_code

    • Added property id (integer)

      Dealer Id

POST /config/dealer

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

New optional properties:

  • contact_number
  • password
  • website
  • zip_code
  • Added property id (integer)

    Dealer Id

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • contact_number

    • password

    • website

    • zip_code

    • Added property id (integer)

      Dealer Id

GET /config/dealer/{dealer_code}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • contact_number

    • password

    • website

    • zip_code

    • Added property id (integer)

      Dealer Id

DELETE /config/dealer/{dealer_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • contact_number

    • password

    • website

    • zip_code

    • Added property id (integer)

      Dealer Id

PATCH /config/dealer/profile/shift-digital-dealer-id/{dealer_profile_id}/{shift_digital_dealer_id}

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • contact_number

    • password

    • website

    • zip_code

    • Added property id (integer)

      Dealer Id

GET /config/dealer/fees/filter

Parameters:

Deleted: db_engine in query

Changed: taxable in query

PATCH /config/dealer/profile/unregister-pen-dealer/{dealer_id}

Parameters:

Deleted: db_engine in query

PATCH /config/dealer/profile/stripe-dealer-id/{dealer_profile_id}/{stripe_dealer_id}

Parameters:

Deleted: db_engine in query

GET /config/vehicle_by_vin/{vehicle_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • address

    • body_style

    • body_type

    • city

    • dealer_location_id

    • dealer_url

    • doing_business_as

    • doors

    • drive_train

    • engine

    • engine_cylinders

    • engine_description

    • exterior_color_description

    • exterior_color_manufacturer_code

    • interior_color_description

    • interior_color_manufacturer_code

    • non_package_option_codes

    • non_package_option_descriptions

    • phone_number

    • photo_urls

    • price_2

    • state

    • stock_number

    • transmission_type

    • vehicle_comments

    • vehicle_display_name

    • vehicle_url

    • zip

    • Changed property vehicle_url (string -> object)

      List of vehicle URLs

    • Changed property photo_urls (string -> object)

      List of vehicle photo urls

GET /config/vehicle/{vin}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • address

    • body_style

    • body_type

    • city

    • dealer_location_id

    • dealer_url

    • doing_business_as

    • doors

    • drive_train

    • engine

    • engine_cylinders

    • engine_description

    • exterior_color_description

    • exterior_color_manufacturer_code

    • interior_color_description

    • interior_color_manufacturer_code

    • non_package_option_codes

    • non_package_option_descriptions

    • phone_number

    • photo_urls

    • price_2

    • state

    • stock_number

    • transmission_type

    • vehicle_comments

    • vehicle_display_name

    • vehicle_url

    • zip

    • Changed property vehicle_url (string -> object)

      List of vehicle URLs

    • Changed property photo_urls (string -> object)

      List of vehicle photo urls

POST /config/vehicle/

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

New optional properties:

  • address
  • body_style
  • body_type
  • city
  • dealer_location_id
  • dealer_url
  • doing_business_as
  • doors
  • drive_train
  • engine
  • engine_cylinders
  • engine_description
  • exterior_color_description
  • exterior_color_manufacturer_code
  • interior_color_description
  • interior_color_manufacturer_code
  • non_package_option_codes
  • non_package_option_descriptions
  • phone_number
  • photo_urls
  • price_2
  • state
  • stock_number
  • transmission_type
  • vehicle_comments
  • vehicle_display_name
  • vehicle_url
  • zip

  • Changed property vehicle_url (string -> object)

    List of vehicle URLs

  • Changed property photo_urls (string -> object)

    List of vehicle photo urls

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    New optional properties:

    • address

    • body_style

    • body_type

    • city

    • dealer_location_id

    • dealer_url

    • doing_business_as

    • doors

    • drive_train

    • engine

    • engine_cylinders

    • engine_description

    • exterior_color_description

    • exterior_color_manufacturer_code

    • interior_color_description

    • interior_color_manufacturer_code

    • non_package_option_codes

    • non_package_option_descriptions

    • phone_number

    • photo_urls

    • price_2

    • state

    • stock_number

    • transmission_type

    • vehicle_comments

    • vehicle_display_name

    • vehicle_url

    • zip

    • Changed property vehicle_url (string -> object)

      List of vehicle URLs

    • Changed property photo_urls (string -> object)

      List of vehicle photo urls

DELETE /config/vehicle/{vehicle_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • address

    • body_style

    • body_type

    • city

    • dealer_location_id

    • dealer_url

    • doing_business_as

    • doors

    • drive_train

    • engine

    • engine_cylinders

    • engine_description

    • exterior_color_description

    • exterior_color_manufacturer_code

    • interior_color_description

    • interior_color_manufacturer_code

    • non_package_option_codes

    • non_package_option_descriptions

    • phone_number

    • photo_urls

    • price_2

    • state

    • stock_number

    • transmission_type

    • vehicle_comments

    • vehicle_display_name

    • vehicle_url

    • zip

    • Changed property vehicle_url (string -> object)

      List of vehicle URLs

    • Changed property photo_urls (string -> object)

      List of vehicle photo urls

PATCH /config/vehicle/{vehicle_id}

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

New optional properties:

  • address
  • body_style
  • body_type
  • city
  • dealer_location_id
  • dealer_url
  • doing_business_as
  • doors
  • drive_train
  • engine
  • engine_cylinders
  • engine_description
  • exterior_color_description
  • exterior_color_manufacturer_code
  • interior_color_description
  • interior_color_manufacturer_code
  • non_package_option_codes
  • non_package_option_descriptions
  • phone_number
  • photo_urls
  • price_2
  • state
  • stock_number
  • transmission_type
  • vehicle_comments
  • vehicle_display_name
  • vehicle_url
  • zip

  • Changed property vehicle_url (string -> object)

    List of vehicle URLs

  • Changed property photo_urls (string -> object)

    List of vehicle photo urls

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    New optional properties:

    • address

    • body_style

    • body_type

    • city

    • dealer_location_id

    • dealer_url

    • doing_business_as

    • doors

    • drive_train

    • engine

    • engine_cylinders

    • engine_description

    • exterior_color_description

    • exterior_color_manufacturer_code

    • interior_color_description

    • interior_color_manufacturer_code

    • non_package_option_codes

    • non_package_option_descriptions

    • phone_number

    • photo_urls

    • price_2

    • state

    • stock_number

    • transmission_type

    • vehicle_comments

    • vehicle_display_name

    • vehicle_url

    • zip

    • Changed property vehicle_url (string -> object)

      List of vehicle URLs

    • Changed property photo_urls (string -> object)

      List of vehicle photo urls

GET /config/vehicle-detail/{vin}

Parameters:

Deleted: db_engine in query

GET /config/inventory/filter

Parameters:

Added: internet_price_from in query

Added: internet_price_to in query

Added: year_from in query

Added: year_to in query

Deleted: db_engine in query

Changed: listing_status in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

POST /config/vehicle-detail/

Parameters:

Deleted: db_engine in query

PATCH /config/vehicle-detail/{vehicle_detail_id}

Parameters:

Deleted: db_engine in query

DELETE /config/vehicle-detail/{vehicle_id}

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/inventory/attached-option

Parameters:

Deleted: db_engine in query

POST /config/inventory-list-import/{dealer_id}

Parameters:

Deleted: db_engine in query

GET /config/financial-insurance

Parameters:

Deleted: db_engine in query

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

POST /config/financial-insurance

Parameters:

Deleted: db_engine in query

GET /config/financial-insurance/{financial_insurance_id}

Parameters:

Deleted: db_engine in query

DELETE /config/financial-insurance/{financial_insurance_id}

Parameters:

Deleted: db_engine in query

PATCH /config/financial-insurance/{financial_insurance_id}

Parameters:

Deleted: db_engine in query

DELETE /config/financial-insurance/delete-all/{dealer_id}

Parameters:

Deleted: db_engine in query

GET /config/integration/lender

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property is_parent_active (boolean)

      Parent Lender Integration Status

POST /config/integration/lender

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

  • Added property is_parent_active (boolean)

    Parent Lender Integration Status

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property is_parent_active (boolean)

      Parent Lender Integration Status

GET /config/integration/lender/{lender_integration_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_parent_active (boolean)

      Parent Lender Integration Status

DELETE /config/integration/lender/{lender_integration_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_parent_active (boolean)

      Parent Lender Integration Status

PATCH /config/integration/lender/{lender_integration_id}

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

  • Added property is_parent_active (boolean)

    Parent Lender Integration Status

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property is_parent_active (boolean)

      Parent Lender Integration Status

GET /config/integration/dealer

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property is_parent_active (boolean)

      Parent Lender Integration Status

GET /config/integration/dealer/{dealer_id}

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property LenderIntegration (object)

      Id for lender integration

      • Added property is_parent_active (boolean)

        Parent Lender Integration Status

GET /config/integrations/dealer/check-dealer-pen-registration

Parameters:

Deleted: db_engine in query

GET /config/integrations/dealer/check-dealer-stripe-registration

Parameters:

Deleted: db_engine in query

POST /config/get_event_associated_checklist/

This API helps to evaluate given criteria and retrive configured checklist(s)

Parameters:

Deleted: db_engine in query

POST /config/create_event_criteria_association/

This API helps us to associate an event and criteria with checklist.

Parameters:

Deleted: db_engine in query

Request:

Changed content type : application/json

New required properties:

  • payload

  • Added property payload (object)

    • Property event_name (string)

    • Property checklist_name (string)

    • Property criteria (array)

      Items (object):

      • Property sequence (integer)

      • Property operands (array)

        Items (object):

        • Property field (string)

        • Property operator (string)

        • Property value (object)

        • Property inner_sequence (integer)

        • Property inner_condition (string)

      • Property condition (string)

DELETE /config/delete_checklist_by_name/{checklist_name}

This API helps to remove all details of the specified checklist and all its associations

Parameters:

Deleted: db_engine in query

GET /config/get_checklist_by_name/{checklist_name}

This API helps to retreive active checklist and event criteria associated with it.

Parameters:

Deleted: db_engine in query

GET /config/asset-make

Parameters:

Deleted: db_engine in query

POST /config/asset-make

Parameters:

Deleted: db_engine in query

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

Parameters:

Deleted: db_engine in query

GET /config/all-asset-make

Parameters:

Deleted: db_engine in query

GET /config/asset-make/{make_id}

Parameters:

Deleted: db_engine in query

DELETE /config/asset-make/{make_id}

Parameters:

Deleted: db_engine in query

PATCH /config/asset-make/{make_id}

Parameters:

Deleted: db_engine in query

GET /config/asset-model/filter

Parameters:

Deleted: db_engine in query

GET /config/financial-product/filter

Parameters:

Deleted: db_engine in query

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

        Changed items (object):

        • Added property user_id (integer)

          DealershipModel dealer id

GET /config/master-list-accessorie/filter

Parameters:

Deleted: db_engine in query

GET /config/dealer/option/filter

Parameters:

Deleted: db_engine in query

POST /config/dealer/configurations

Parameters:

Deleted: db_engine in query

GET /config/financial-insurances/filter

Parameters:

Deleted: db_engine in query

GET /config/integrations/lender/filter

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property is_parent_active (boolean)

        Parent Lender Integration Status

GET /config/integrations/dealer/filter

Parameters:

Deleted: db_engine in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property is_parent_active (boolean)

        Parent Lender Integration Status

POST /config/checklist_response_verification/

This API helps to verify checklist responses.

Parameters:

Deleted: db_engine in query

GET /config/asset-make/filter

Parameters:

Deleted: db_engine in query

GET /config/asset-data/filter

Parameters:

Deleted: db_engine in query

PATCH /config/update_checklist/

This API helps in to update checklist details like question and answers.

Parameters:

Deleted: db_engine in query

POST /config/create_checklist/

This API helps to create new checklist. We can create multiple checklists in one iteration.

Parameters:

Deleted: db_engine in query

Version 1.0.9Version 1.0.7