FREQUENTLY ASKED QUESTIONS
HOW TO INSTALL WEBHDT NOPCOMMERCE PLUGINS?
HOW DO I REGISTER WITH CANADA POST?
HOW DO I CONFIGURE CANADA POST PLUGIN?
I do not want to accept online payments, how do I add Collect on Delivery (COD) option?
We require a signature for all package deliveries. How do I add Include Signature Option?
We want to print shipping labels on thermal printer. How do we change the settings for the labels to fit standard label printers?
HOW DO I TEST THE PLUGIN? CAN I TEST THE PLUGIN IN SANDBOX MODE?
WE RECEIVED AN ORDER, WHAT'S NEXT? HOW DO WE CREATE SHIPMENT LABELS?
PACKAGE IS READY TO BE SHIPPED, HOW DO I PRINT SHIPMENT & RETURN LABELS?
HOW DO I TRANSMIT THE SHIPMENT(S) AND GET A MANIFEST TO PROVIDE TO CANADA POST?
HOW DO I VOID SHIPMENTS?
HOW TO INSTALL WEBHDT NOPCOMMERCE PLUGINS? (INSTALLATION GUIDELINES)
- Download the plugin compressed (zip) package from your downloaded products page to your local machine.
- Unzip the package to a local folder.
- Locate the folder of your corresponding nopCommerce version.
- Copy the “webhdt.nop.plugin.CanadaPost” folder “as is” under the nopCommerce version named to the plugins folder of your nopCommerce installation.
- Go to your nopCommerce administration – configuration – plugins and click on Reload list of plugins button.
- Locate the webhdt plugin and click on install.
HOW DO I REGISTER WITH CANADA POST?
The first step after installing the plugin is to register your account using your existing Canada Post credentials or sign up for a new account.
- Go to the plugin configuration page
- Click on the “Register account” button to start the process. You will be directed to the Canada Post secure website login page.
- Log into your account or sign up for a new Canada Post account. The secured login connection will allow webhdt Canada Post plugin to acquire the shipping rates directly from Canada Post web service API.
Note: Canada Post may request your credit card information during registration. The credit card information is required and stored with Canada Post and will only be used for transactions. webhdt inc. does not have access to your account. Find out more about Canada Post Pricing Rewards; Solutions for Small Business Click here for more information.
Start by completing the Canada Post registration through the plugin page. The customer number, username and password will be automatically updated once registration is completed. Registration will unlock account setting fields. Configure and adjust settings based on your business needs. (Field description details are listed below).
Field descriptions
| Field name |
Description |
|
Username
|
|
Password
|
|
Customer number
|
|
Populated automatically by Canada Post after registering account. |
| Contract ID |
Populated by Canada Post for commercial account holders only. |
|
Sender Company Name
|
|
Sender Contact Number
|
|
This info will appear in the "From" address of the shipping label. Blank fields will be removed in the address formatting. Sender Company name of the corresponding sender. Sender Contact number is the phone number of the sender. |
| Quote type |
Options are “commercial” or “counter”. It is set to "commercial" if not specified. "Commercial" will return the discounted price for the commercial customer or Solutions for Small Business member. "Counter" will return the regular price paid by consumers. |
| Service Code |
A specific Canada Post service to be rated. If no instances of service-code are included in the request, all services applicable to the shipment and destination will be rated and returned. |
| Log API calls |
Plugin will store in the Shipments log all calls made to the API for troubleshooting purposes. It is recommended to set to True only during troubleshooting. |
| Handling fees |
Dollars amount added to the quote received from the Canada post API service. |
| Turnaround time (in hour) |
Number of business hours added to the estimated delivery date. |
Shipping rate computation method will also need to be activated. Go to Configuration – Shipping – Shipping providers and enable the activate checkbox.
CANADA POST WEB SERVICES NOPCOMMERCE SHIPPING PLUGIN
A few important notes:
- The Canada Post plugin uses the combined weight of the shopping cart items to provide shipping quotes.
- Assign the proper weight and unit of measure to individual products. The plugin, if required will convert based on the ratio’s provided by you in the Shipping configuration of nopCommerce.
- Oversized items will not return shipping rates and they need your special attention during your development.
- Refer to the guide for more info about the Canada Post services. Click here for Canada Postal Guide
I do not want to accept online payments, how do I add Collect on Delivery (COD) option?
The COD option (Collect on Delivery) is available but by default it is disabled. Change the settings value from "False" to "True". Use setting Include COD option (canadapostsettings.includecodoptioncode). Changes to this setting will impact to all shipments. Find out more about Collect On Delivery option.
We require a signature for all package deliveries. How do I add Include Signature Option?
The Signature Option is available but by default it is disabled. Change the settings value from "False" to "True". Use setting Signature Option (canadapostsettings.includesignatureoptioncode). Changes to this setting will impact to all shipments.
We want to print shipping labels on thermal printer. How do we change the settings for the labels to fit standard label printers?
The Print thermal labels is available but by default it is disabled. Change the settings value from "False" to "True". Use setting Print thermal labels (canadapostsettings.printinthermal).
HOW DO I TEST THE PLUGIN? CAN I TEST THE PLUGIN IN SANDBOX MODE?
Yes, you can test the plugin using sandbox mode.
Replace the following settings to connect to the testing environment (sandbox mode). Note that you need to save your existing information and revert when ready to go live.
PLUGIN IN SANDBOX MODE
| canadapostsettings.sandboxbaseurl: |
https://ct.soa-gw.canadapost.ca |
| canadapostsettings.customernumber: |
2004381 |
| canadapostsettings.contractid: |
42708517 |
| canadapostsettings.username: |
6e93d53968881714 |
| canadapostsettings.password: |
0bfa9fcb9853d1f51ee57a |
| canadapostsettings.useplatformid: |
False |
| canadapostsettings.usesandbox: |
True |
WE RECEIVED AN ORDER, WHAT'S NEXT? HOW DO WE CREATE SHIPMENT LABELS?
The process of preparing a shipment label starts after an order is placed and from the shipping info tab of the order details page.
- Click on the “Add shipment” button to create a new shipment to the order.
- Leave the “Tracking number” and “Admin comment” fields blank if you want to create labels from Canada Post service. (Note: Otherwise you may enter info but you cannot use the Canada Post web service.)
- Go to shipments page from “Sales” or “Canada Post” plugin menu sections.
- Select the shipment by setting the first column checkbox to true.
- Click on the “Create Shipment (Selected)” button to request and acquire a tracking number from Canada Post and assign the shipment a GroupID.
Note:
- Prior to creating shipments make sure you have set the shipping origin address. The origin address can be updated on the configuration shipping settings page. IMPORTANT: Shipping postal code should be in uppercase characters without any spaces.
- For non-contract Canada Post merchants, the “Date shipped” value will be set after creating the shipment label.
- Group Id’s are assigned based on the day the shipment is created and destination country code (CA, US or IN for International). A manifest is generated for each group.
- Update email template to add tracking number. Go to Blog. Clickez ici pour Blog en francais
PACKAGE IS READY TO BE SHIPPED, HOW DO I PRINT SHIPMENT & RETURN LABELS?
To print shipment labels a shipment must have been assigned a tracking number from Canada Post.
- From the shipments page, click on the “view” link to see the shipment details.
- You have the option to Print the shipment label or Return label by clicking on the appropriate button.
- Save or open the PDF file.
Note: Return labels can only be created if the shipment originates in Canada and is destined for delivery in Canada.
HOW DO I TRANSMIT THE SHIPMENT(S) AND GET A MANIFEST TO PROVIDE TO CANADA POST?
After creating your shipment and printed labels you must transmit your shipments to get a manifest.
- Go to Shipments page from “Sales” or “Canada Post” plugin menu sections.
- Select the shipment(s) by setting the first column checkbox to true, only select those you have already created shipment for. You will know if there is a tracking number already assigned.
- Click on the “Transmit & Get Manifest (Selected)” button to transmit the shipments and prepare to print manifest.
- Go to “Get Manifest” page from “Canada Post” plugin menu section
- Select the groupid you want to print manifest for and click on the small red PDF icon logo to download the Manifest.
Note:
- Important to create manifest, if not Canada Post will charge you for unpaid shipments and apply a per-item surcharge. To avoid fees, you can void shipments that were not transmitted. As an alternative, a shipment can be excluded from a transmit request and therefore remain active for inclusion in a subsequent transmit request.
- If you are testing, make sure you are in sandbox environment otherwise you will be billed for any manifests submitted through a Transmit Shipments.
HOW DO I VOID SHIPMENTS?
Void shipment is used to cancel shipment created before transmitting it to Canada Post. Voiding shipments indicates that the previously printed label is spoiled or will otherwise not be used.
- From the shipments page, click on the “view” link to see the shipment details
- Click on the “Void Shipment” button to cancel the shipment created with Canada Post
To validate a shipment is voided you should see a check mark under “Shipment Voided” column of the Shipments page.
