Support Menu

Magento 2 Implementation Guide

This guide is written for Magento developers. Use the following instructions to install the Route extension and implement the Route Package Protection widget on your Magento 2 website. (If Route is already implemented on your website, use these instructions to upgrade to the latest Route extension and Package Protection widget.)

Please note: This extension is optimized for Magento 2.4.4 or greater. If you use Magento 2.4.3 or below, please contact support.

Process overview: 

Part 1: Install the Route extension on your website

Part 2: Create a Route account

Part 3: Verify tokens

Part 4: Enable the Route extension and Package Protection widget 

 

Part 1: Install the Route extension on your website 

    1. Login to your Magento dashboard
    2. In Adobe Commerce Marketplace, search for “Route”
    3. Click Route Shipping Protection and proceed to purchase the free Route extension

 Note: No payment is required.

    1. Click Install
    2. In the Extensions tab, review the How to Install instructions

Note: Ensure you have your composer set up with your access key provided by Adobe Commerce Marketplace. Find your access key in your profile, or by clicking the link in the instructions. 

    1. In your root directory, install the Route extension with this command : composer require route/route-m2
    2. Enter bin/magento setup:upgrade. The Route module should as Module ‘Route_Route’ (as shown below)

magento-2-module-route-route.png

    1. Enter bin/magento setup:di:compile
    2. Clean Magento cache by entering bin/magento cache:clean
    3. Sign out of your Magento dashboard and immediately sign back in. You will be redirected to a page where you will create an account for the Route Merchant Portal. Proceed to Part 2.

Note: If you are not redirected, you may have an existing Route account. Log in to your Merchant Portal. If you do not have an existing account and are not redirected, contact support. 

 

Part 2: Create a Route account

    1. Enter your details to create a Route account 
    2. From your Route Merchant Portal, use the support chat button on the bottom right of the screen, or send an email to your dedicated Route representative, to notify the Route implementation team to complete your account setup. Use the following message:

“I am a new Route Magento 2 merchant and have installed Route extension [insert version information, found under your Extensions in Adobe Commerce Marketplace]. Please complete my account setup.”

You will receive an email from a Route representative within two business days noting that your account setup is complete. Proceed to Part 3.

 

Part 3: Verify tokens 

Your Route Public Token and Secret Token should already be populated in your Magento dashboard. To verify, follow these directions: 

    1. In your Magento dashboard, go to Stores > Configuration > Route > Integration Setup

If tokens are displayed, continue to Part 4. 

If tokens are not displayed, follow the instructions below to retrieve them from your Route Merchant Portal before proceeding.

    1. In your Route Merchant Portal, go to the Admin tab
    2. Copy-paste the Public Token into the corresponding field in your Magento dashboard
    3. Copy-paste the Secret Token it into the corresponding field in your Magento dashboard
    4. Click Save Config. Proceed to Part 4.

 

Part 4: Enable the Route extension and Package Protection widget 

    1. In your Magento dashboard, go to Integration Setup 
    2. Confirm Enable Route Extension is set to Enable. Or, if set to Disable, click dropdown and set to Enable. Save Config.
    3. In your Route Merchant Portal, go to Admin > Route Configuration. Verify that Route Package Protection is Enabled. If set to Disabled, click edit and set to Enabled. Save.

At this point, the Route Package Protection widget should be properly configured on your checkout page, below the Shipping Methods section. To verify proper configuration:

    1. Navigate to your website and add any product to your cart
    2. Go to Checkout and confirm widget placement

If the widget is not displaying, contact support.