1 post / 0 new
Log in or register to post comments
Thu, 10/20/2022 - 11:47
#1
FortellisAdvocate
Migrating to Repair Order V2 Bundle

Full RO Access in No Time 

Industry providers now have write-back access to Repair Orders within the CDK DMS. Many integrations have been developed to create, read, edit, and monitor repair orders quickly and easily, using the CDK Drive Repair Order API bundle on Fortellis. 

Building on the popularity of the original bundle, CDK Drive Repair Order V2 Bundle adds more ways for you to develop faster and more robust integrations. This new bundle version includes the following APIs: 

What’s New? 

CDK Drive Repair Order API now includes the ability to create an internal RO, without first creating a customer. 

  • The new bundle now consists of 6 APIs​ 
  • To support the creation of special PDI and vehicle inspection orders, a new dealership specific option allows you to create “internal” repair orders where the repair order is not associated with a customer. This feature was added based on multiple ISV (Independent Software Vendors) requests​ 
  • Expanded capability to queryRepairOrders, by following criteria:​ 
    • serviceAdvisorId ​ 
    • vehicleId  ​ 
    • CustomerId​ 
  • Added a 'jobStarted' flag to each service line item. ISV's application can then avoid updating these service lines and lower the amount of errors /delay in writing service lines​ 
  • Moved the common helper lookup functions to the CDK Drive Workshop Management API to facilitate better API management​ 
  • New endpoint-based subscription pricing model​ 

When Do I have to Switch? 

CDK Drive Repair Order Bundle V1 will sunset following the End-of-Life schedule listed below. We encourage you to begin the migration process soon to take advantage of new functionality and assure you have time to complete this migration before the planned end date.  

  • 9/30/2022 - CDK Drive Repair Order Bundle V2 became available for all developers to begin using 
  • 10/1/2022 - CDK Drive Repair Order Bundle V1 will be removed from the API directory. Existing certified Applications will be supported 
  • 1/30/2023 - No new Certification on V1 will be permitted 

How Do I Switch? 

Migration from Repair Order Bundle V1 to V2 will require minor adjustments to your code pointing to new endpoints. These endpoints have been designed to add functions while preserving V1 functions.  Our team suggests you begin with the following steps: 

Adding new APIs to your existing App in Developer Network 

  1. To begin, log into your Fortellis account and navigate to the Developer Network screen.  
  2. Open your current App used for production and click the “Edit” button on the top right of the screen. 
  3. Using the search function, locate the “CDK Drive Repair Order” & the “CDK Drive Workshop Management” APIs
    1. Check the box on the left of each API when located.  
    2. This will place each API in the “Selected APIs” list at the bottom of the screen
  4. For each new API  
    1. click the “Select Plan” link to choose your desired price plan 
    2. click the “Review Terms” link to agree to the terms of use for the API
  5. ​Click the purple “Save” button at the bottom to complete the process  

Once this is done you will be able to call both version 1 and version 2 in tandem for your Sandbox environment. Please note that V2 provides a 30-day trial before billing begins. We encourage your team to complete internal development changes, testing and migration within the 30-day window to avoid being billed for use of both API bundles. 

Updating your Code 

If you are using the following endpoints in CDKDrive Repair Orders v1

You will need to change the base path from https://api.fortellis.io/cdkdrive/service/v1/repair-orders/ 

To https://api.fortellis.io/service/cdk-drive/v2/repair-orders/ 

 

If you are using the following endpoints in CDKDrive Repair Orders v1 

You will need to change the base path from https://api.fortellis.io/cdkdrive/service/v1/repair-orders/lookups/ 

To https://api.fortellis.io/service/cdk-drive/v1/workshop-management/ 

 

After you have completed your development changes and completed your internal testing, please email fortellis.engagement@fortellis.io with an updated workflow document. 

The engagement office will review the workflow and guide you through the steps for migrating to production. 

Please note completing this version migration with the Fortellis team will result in all existing subscriptions to be functional on V2 and there will be no need to have dealers re-activate connections. 

  1. Migrating to Production for APP Publishers that are in GR with existing dealers
    1. No workflow Changes  
      1. Light certification on V2 
      2. Fortellis completes activation of V2 for Production dealers
      3. 7-day grace period for tandem use of V1 and V2 in production 
      4. Fortellis completes deactivation of V1 for Production dealers 
      5. Migration considered complete 
      6. You move to section “Promoting the New API Functions in Fortellis Marketplace”  
    2. Workflow changes 
      1. Full certification on V2 
      2. Fortellis completes activation of V2 for Production dealers 
      3. 7-day grace period for tandem use of V1 and V2 in production 
      4. Fortellis completes deactivation of V1 for Production dealers 
      5. Migration considered complete 
      6. You move to section “Promoting the New API Functions in Fortellis Marketplace” 

Promoting the New API Functions in Fortellis Marketplace 

  1. Once your migration is complete you should update your App listing in Marketplace 
  2. Begin by logging into your account and navigate to Marketplace Account -> Apps 
  3. Select the correct App listing to update 
  4. Select “Manage Listing versions” from the top left navigation menu 
  5. From the list of App versions, click the “Edit” button for the most recent version, this should be on the top of the list 
    1. If your listing has not been published previously 
      1. Complete all required fields 
    2. If your listing is already published, this will create a new version 
      1. This new listing will be a draft, using all the values from the existing listing 
      2. Click the “What’s New” section and add text outlining any new functions offered using Repair Order V2 for dealer awareness 
      3. Make any other changes to the listing as needed​
    3. Save your listing 
    4. Submit the listing for review 
  6. You will be notified once your draft listing is approved 
  7. Log into your account to publish the new listing
    1. replacing the previous version in the Marketplace 
  8. You are now ready to use the NEW Marketplace dealer activations 
    1. A quick 30-minute call gets you migrated from the eStore! 
      1. Learn more here: https://docs.fortellis.io/docs/marketplace/marketplace-for-apps/activating-apps/ 
Top