Magento2 / Purolator LTL Freight

/Magento2 / Purolator LTL Freight
Magento2 / Purolator LTL Freight2018-11-14T14:25:18+00:00

LTL Freight Quotes

Purolator Edition for Magento 2.x

Purolator is headquartered in Mississauga, Ontario and is Canada’s premier shipping company. If you don’t have a Purolator account number, contact them at 888-744-7123, or register online.

Features

Displays negotiated LTL shipping rates in the shopping cart.

Provides quotes for shipments within Canada and to the United States.

Define a custom label to identify the LTL freight rate in the cart.

Elect to display carrier transit times with rate estimates.

Define multiple warehouses.

Identify products that drop ship from vendors.

Product specific shipment parameters: weight, dimensions, freight class.

Option to set a product’s freight class automatically through the built in density calculator.

Support for variable products. Shipment parameters can be set differently for each product variation.

Option to always include the residential delivery charge.

Option to include lift gate delivery charge.

Option to mark up shipping rates by a set dollar amount or by a percentage.

Works seamlessly with other quoting apps published by Eniture Technology.

Current version: 1.0.0

Requirements

An installation of Magento CE (Version 2.x).

A Purolator account number.

Your username and password to purolator.com.

Your Purolator Production Key.

FAQ’S

How do I get this application?

This application can be downloaded from this website after selecting a subscription package. It will also be available from Magento Connect, Magento’s online marketplace for extensions. If you download it from Magento Connect, you will still need to return to eniture.com to choose a subscription package and obtain a license key.

Will this work with Magento Enterprise Edition?

We have reports of companies using the extension successfully in Magento Enterprise. You can install a trial version and verify that it will work for you. Be advised though, we can not provide support for installations on Magento Enterprise Edition.

How do I get a Purolator account number?

Contact them at 888-744-7123, or register online.

Where do I find my purolator.com username and password?

Contact Purolator customer service at 888-744-7123, or try to recover it online.

Where do I get my Purolator Production Key?

Obtaining a Purolator Production Key is done on purolator.com and requires a few steps. Refer to the Documentation tab on this page for detailed instructions.

How do I get a license key for the plugin?

You must register your installation of the plugin, regardless of whether you are taking advantage of the trial period or purchased a license outright. At the conclusion of the registration process an email will be sent to you that will include the license key. You can also login to eniture.com using the username and password you created during the registration process and retrieve the license key from the My Licenses tab.

How do I change my plugin license from the trial version to one of the paid subscriptions?

Login to eniture.com and navigate to the My Licenses tab. There you will be able to manage the licensing of all of your Eniture Technology plugins. Refer to the Documentation tab on this page for more thorough instructions.

How do I install the plugin on another website?

The plugin has a single site license. To use it on another website you will need to purchase an additional license. If you want to change the website with which the plugin is registered, login to eniture.com and navigate to the My Licenses tab. There you will be able to change the domain name that is associated with the license key.

Do I have to purchase a second license for my staging or development site?

No. Each license allows you to identify one domain for your production environment and one domain for your staging or development environment. The rate estimates returned in the staging environment will have the word “Sandbox” appended to them.

Why isn’t the plugin working on my other website?

If you can successfully test your credentials from the Connection page then you have one or more of the following licensing issues: 1) You are using the license key on more than one domain. The licenses are for single sites. You will need to purchase an additional license. 2) Your trial period has expired. 3) Your current license has expired and we have been unable to process your form of payment to renew it. Login to eniture.com and go to the My Licenses tab to resolve any of these issues.

Why are the shipment charges I received on the invoice from Purolator different than what was quoted by the app?

Common reasons include a difference in the quoted versus billed shipment parameters (weight, dimensions, freight class), or additional services (such as residential delivery) were required. Compare the details of the invoice to the shipping settings on the products included in the shipment. Consider making changes as needed. Remember that the weight of the packing materials is included in the billable weight for the shipment. If you are unable to reconcile the differences call Purolator customer service for assistance. (888-744-7123)

Why do I sometimes get a message that a shipping rate estimate couldn’t be provided?

There are several possibilities:

The most common reason is that one or more of the products in the shopping cart did not have its shipment parameters (weight, dimensions, freight class) adequately populated. Check the settings for the products on the order and make corrections as necessary.

The city entered for the shipping address may not be valid for the postal code entered. A valid City+State+Postal Code combination is required to retrieve a rate estimate. Contact us by phone (404-369-0680) or email (support@eniture.com) to inquire about Address Validation solutions for this problem.

Your shipment exceeded constraining parameters of Purolator’s web service.

The Purolator web service isn’t operational.

Your Purolator account has been suspended or cancelled.

There is an issue with the Eniture Technology servers.

Your subscription to the plugin has expired because payment could not be processed.

There is an issue your server.

How do I determine the freight class for my product(s)?

The easiest thing to do is to contact your Purolator representative and ask for assistance. However, the official source is the National Motor Freight Classification (NMFC) directory maintained by the National Motor Freight Transportation Agency (NMFTA.org). You can purchase a hard copy of the directory or obtain an online subscription to it from their web site.

How does the density calculator work?

The density calculator will calculate a freight class by performing a calculation using the product weight and dimensions as inputs. In most cases the returned freight class will match the product’s (commodity’s) freight class as recorded in the National Motor Freight Classification (NMFC) directory. However, this is not always true and in the event there are differences, the freight class recorded in the National Motor Freight Classification (NMFC) directory takes precedence. An incorrectly identified freight class can result in unexpected shipping charges and even fees. You are solely responsible for accurately identifying the correct freight class for your products. If you need help doing this, contact your Purolator representative for assistance.

User’s Guide

If you are taking advantage of a trial subscription, the plugin will stop working when the trial period ends. Be sure to read the Manage Your License section to learn how to upgrade your subscription.

Overview

1. Download the LTL Freight Quotes module

Return to top.

When you select a subscription package you will be presented with a registration form. The email address and password you enter will serve as your credentials to eniture.com. Use these to gain access to your customer dashboard where you can download your module, manage your licenses and update your payment information.

When you download the module installation file, be sure to save it to a familiar location. You will need to navigate to the file during the installation process.

2. Prepare your server to perform the module installation

Return to top.
When installing a new module, Magento 2 checks to see if CRON jobs is setup and at least one CRON job is defined. You will receive an error during the module installation process if this is not the case. Click here to view Magento’s online documentation on CRON jobs.

3. Install the module

Return to top.

Extract the contents of the ZIP file you downloaded in Step 1. Put the Purolator folder in the /app/code folder. Login to the Magento Admin Panel and navigate to System > Web Setup Wizard.

Click on the Component Manager tile.

Locate the module by scrolling through the Component Name column and then click Select > Enable.

On the Step 1: Readiness Check page, click the Start Readiness Check button and after readiness is confirmed, click the Next button.

On the Step 2: Create Backup page, uncheck all the options and then click the Next button.

On the Step 3: Enable Module page, click the Enable button to continue.

If you’ve installed the module correctly you will be presented with a success message.

4. Flush the Magento cache

Return to top.

Select Cache Management from the System menu.

Click on the Flush Magento Cache button to empty the cache.

5. Get your Purolator Production Key

Return to top.

To successfully connect the app to Purolator, in addition to a Purolator account, and purolator.com username and password, you also need a Purolator Production Key. If you don’t have one, sign into purolator.com and navigate to Purolator E-Ship Resource Centre.On the left hand side of the page, locate and click on the button to register for Purolator E-Ship Web Services.

purolator-eship-registration-button

You will be presented with three choices. Choose the Corporate Account Holder option.

purolator-eship-registration

Complete the Profile Information form and click the Submit Registration button.

You will receive an email from Purolator containing a link to use to complete the registration process. Click on it and log back into the E-Ship Resource Center. A message will appear informing you that your registration is complete.

purolator-eship-registration-complete

Now you’re ready to request your Production Key. Sign back into the Purolator E-Ship Resource Centre. You will be presented with the main Purolator E-Ship Resource Centre page. Click on the Ready for Production tile.

purolator-eship-dashboard

Select the Corporate option.

purolator-eship-prod-key-request

Complete the form and click the Submit button. The Production Key you receive will be inactive until Purolator verifies the request. A Purolator representative may contact you for security purposes before the Production Key is activated. If you intend to use the app’s multiple warehouse and/or drop ship feature, ask the Purolator representative to remove the sender address restriction.

Once the Production Key is activated you can connect the Purolator LTL Freight Quotes app to the Purolator E-Ship Web Service by following the instructions in Step 3.

6. Enter and choose the module settings

Return to top.

Navigate to Store > Configuration

Click on the Purolator LTL Freight entry on the left side of the page.

6a. Connection Settings

Return to top.

Click on the link for Connection Settings and enter the connection information.

Enabled (Yes|No) Controls whether or not the extension will display shipping rate estimates in the shopping cart.
Production Key The Production Key you obtained in Step 5 of these instructions.
Production Password The Production Password you were emailed as a result of completing Step 5 of these instructions.
Registered Account Number Your Purolator account number.
Physical Address The primary physical address associated with your account. Identify the country using the two character “CA” abbreviation.
Plugin License Key The plugin license key is issued by Eniture Technology. A license key is provided to registered users only. If you already have a license key but don’t recall what it is, sign into eniture.com and retrieve it from the My Licenses tab of the dashboard. Otherwise, access the Purolator LTL Freight Quotes product detail page, select a subscription package and complete the registration process.

When you’re done save your connection settings and then test them by clicking on the Test Connection button at the bottom of the section. A message will display telling you if the a connection to the Purolator servers was successful. If you receive an error, confirm the values you entered and try again. Be particularly attentive to capitalization. Most of the information you enter in this section is case sensitive.

6b. Identify your warehouse and drop ship locations

Return to top.

Click the Add button in the appropriate sections to add warehouse and drop ship locations. Warehouses should have a complete inventory of all products not otherwise identified as drop shipped items. If you have more than one warehouse defined, the warehouse closest to the shopper will be used to retrieve shipping rate estimates. You should define at least one warehouse, even if all of your products are drop shipped. This insures that quotes will be returned in the event the drop ship location was overlooked when the product entry was created.Drop ship locations usually represent vendors that supply items that you don’t inventory. These items are shipped directly to your customer on your behalf. When an order includes drop shipped items the shopping cart will display a single figure for the shipping rate estimate that is equal to the sum of the cheapest option for each shipment required to fulfill the order.

6c. Quote settings

Return to top.

Click on the link for Quote Settings and make your selections.

Service Types Select the services you’d like to offer your shoppers. To make multiple selections hold down the Ctrl key (PC) or Command key (Mac) and click on the services.
Show Delivery Estimate When checked, the service’s transit time estimate will appear with the quote(s).
Residential Delivery When checked, the quotes will include each carrier’s residential delivery fee.
Tailgate Fee When checked, the quotes will include the carrier’s tailgate delivery fee.
Label As (Standard) What the user sees for Purolator’s standard LTL service. If left blank, Freight Standard will be displayed as the shipping method.
Label As (Expedited) What the user sees for Purolator’s expedited LTL service. If left blank, Freight Expedited will be displayed as the shipping method.
Handling Fee / Markup Increases the amount of each returned quote by a specified amount prior to displaying it/them in the shopping cart. The number entered will be interpreted as dollars and cents unless it is followed by a % sign. For example, entering 5.00 will cause $5.00 to be added to the quotes. Entering 5.00% will cause each quote to be multiplied by 1.05 (= 1 + 5%).
Return LTL quotes when an order’s parcel shipment weight exceeds 150 lbs When checked, the LTL Freight Quote plugin will return quotes when an order’s total weight exceeds 150 lbs (the maximum permitted by FedEx and UPS), even if none of the products have settings to indicate that it will ship LTL. To increase the accuracy of the returned quote(s), all products should have accurate weights and dimensions.

7. Product Settings

Return to top.

Now that the application settings have been established, it’s time enter the product settings. Repeat these instructions for every product that you want to ship via LTL freight. Select Products > Catalog > Products from Magento Admin Panel menu. Locate the product on the list and choose it by clicking on it. You’ll be delivered to the product’s details page.

Pay close attention to the shipping related settings that are required. LTL quotes will not be retrieved if these settings are missing.

Ship Via LTL Freight Required. Select Yes to indicate that the item ships LTL freight. If set to No quotes for LTL freight may still appear during checkout if the total cart weight exceeds 150 LBS and the products in the cart have a freight class and weight associated with them.
Freight Class Required. Select the products freight class. If you are unfamiliar with what a freight class is or how to identify it for a given product, click this link to access a related article in our knowledge base.
Weight Required. Enter the weight of the product in pounds. It should include the weight of any packaging materials that may be required to ship the product, such as cardboard, bubble wrap and styrofoam peanuts.
Length Enter the length of the product in inches. It should include any incremental inches added by packaging materials that may be required to ship the product.
Width Enter the width of the product in inches. It should include any incremental inches added by packaging materials that may be required to ship the product.
Height Enter the height of the product in inches. It should include any incremental inches added by packaging materials that may be required to ship the product.

What your shopper sees

Return to top.

Once you’ve completed the preceding steps, your Magento store is ready to begin offering shipping options for LTL freight. To ensure the best possible outcome, it is highly recommended that freight class, weight and dimensions be entered for every product you sell. The exact presentation of the rates in the checkout process will depend on the options selected in the Quote Settings. The illustration below shows an example with multiple service options enabled.

Managing Your License

Return to top.

You can manage your license by signing into eniture.com with the email address and password you entered when you registered for the extension. After you sign in, My Account will be added to the navigation menu. Click on it to access the Dashboard for your account.

my_account

The most common uses of the Dashboard are to upgrade a trial subscription to a paid subscription, change the URL registered to a license, or to identify the URL of a staging or development site.

Upgrade to a paid subscription

If you fail to upgrade your trial subscription to a paid subscription before the trial expires, the extension will stop working. To upgrade, click on the My Licenses tab, locate the license, and click the Pay Now button.

Choose one of the subscription packages and then enter the information for your payment method. Your extension will be automatically renewed at the end of each subscription period unless you return to the Dashboard and cancel the subscription.

Change the URL registered to a license

The license allows you to use the extension on a single website. To use the extension on additional websites, you must purchase additional licenses. You can change the URL registered on a license at any time. To do so, click on the My Licenses tab, locate the license, and click the Edit button. Enter the new URL into the Licensed Domain field and then click the Update button.

licensed_domain

Identify a staging or development site

The license will allow one staging or development site. Quotes returned to this site will have the word “Sandbox” appended to them. To identify a staging site, click on the My Licenses tab, locate the license, and click the Edit button. Enter the new URL into the Staging Domain field and then click the Update button.

staging_domain