Details

Additional Information

Please Note: You will need to install the Canada Post V2 Unit Convertor module prior to installing the Canada Post 2.0 Shipping Module!! The module is provided free of charge at the time of download

Please Note: If you are not a contract customer with Canada Post, you will not be able to transmit manifests.KB Article

Please Note: Canada Post currently does not pass API testing credentials back as part of the Sign Up process. You will need to retrieve your API development keys (login:password) from Canada Post's site. Please see the FAQ here

To view a demonstration of the installation process, please click on "Product Description" above these instructions to view the video.

Compatible with Community Edition 1.9+ and Enterprise Edition 1.12-1.14

Please consider the following before installing this module:

• Our modules are guaranteed to work on a server running a Linux distribution. We do not test our modules on servers running any version of Windows Server nor Mac OS X Server. Therefore, we cannot warrant or guarantee that these modules will function with desired results if installed on those platforms. Doing so, is of your own accord and we are not held accountable for support on these platforms.
• We recommend that you maintain a backup of your Magento database and Magento site, should things ever go awry. For additional instructions on how to create backups for your site, please refer to these instructions.
• Ensure that you have a compatible version of Magento installed. There are no guarantees that this module will work properly on an earlier version of Magento. Use only the version[s] that the module is intended for.

Removing or disabling a previous installation...

If you have previously installed our Canada Post Shipping module for SellOnline, use the following instructions to disable the module, in order to upgrade to this release, Canada Post 2.0.

1. Go to your Magento site's admin panel. 2. Under System, click on Configuration. 3. Scroll down to the bottom of the page, until you see the heading "Advanced" on the left-hand side. Click on Advanced, under the "Advanced" heading. 4. You should now see a "Disable Modules Output" section. Click on the title to expand the section. 5. Located the module on the list that you wish to disable, and select Disable from the drop-down menu. 6. Click on Save Config to save the configuration. Now the module should be disabled, however, you may need to refresh your cache to view the changes that have taken effect. (System > Cache Management)

If you prefer to do a clean installation of this module, please use the following instructions to remove the module from your site.

• Remove via Magento Connect (only if you orinally installed the module via Magento Connect)
  1. Go to your Magento site's admin panel.
  2. Under System -> Magento Connect, click on Magento Connect Manager.
  3. You will be brought to a page where you will have to input your credentials. They should be the same credentials that you use to log into the admin panel.
  4. Under the section "Manage Existing Extensions", scroll through the list until you see the module you wish to remove.
  5. On the drop-down menu, select "Uninstall" from the list of Actions. Then click on the Commit Changes button.
  6. A terminal-like window should appear at the bottom and give you the results of the uninstallation. If it's successful, proceed to "Performing a fresh installation...". If not, troubleshoot the error.
• Remove via directory traversal (manual deletion)
  • Exercise caution when removing the module with this method. Only remove the files belonging to the module; doing so otherwise, could cause other modules to malfunction.
  • Tip: It helps to have the module extracted in another location so you are able to view the contents that come with the packaged module, while going through your Magento site's directory and removing files concurrently.
  • Common locations for module files:
    • Navigate to 'app/etc/modules/'. Delete 'CanadaPost.xml', and 'Collinsharper_Mfeed.xml' if it exists.
    • Navigate to 'app/code/local/Mage'. Delete the CanadaPost folder (all files in it).
    • Navigate to 'app/code/local/Collinsharper'. Delete the Canadapost and Mfeed folders.

Performing a fresh installation and/or upgrade...

Whether you are performing an upgrade or a clean installation of this module, the instructions will be similar for both cases.

1. Log into your Magento admin panel, if you have not done so.
2. Under System => Magento Connect, click on Magento Connect Manager.
3. You will be brought to a page where you will have to input your credentials. They should be the same credentials that you use to log into the admin panel.
4. If we have provided you with a package file, simply locate the package file on your machine and upload it to your site.
5. A terminal-like window should appear at the bottom and give you the results of the installation. If it's successful, click on the Refresh button to reload the page. You should now see the new module listed at the bottom. If the installation failed, troubleshoot the error.

Module requirements...

• All products are required to have an accurate weight attribute. Failure to do so, may cause the module to produce undesired results.
• A default length, width, and height value must be set in the module's configuration panel. We recommend using the dimensions of your most popular box. The units for length, width and height are the same as specified in System - Configuration - Catalog - Measure Units

Testing the module...

To test the module, follow these instructions:

1. Go to the front end of your Magento site, a.k.a. your store's front page.
2. Add any item to the shopping cart and click on Checkout (or similar).
3. Provide a destination location and click on "Get Quote" to get various shipping methods available.

If you encounter any issues, please download this file, extract & execute the script. Return your results to us by submitting a ticket with the results attached.

Configuration Fields

Calculate Handling Fee

The Handling Fee is not handled by Canada Post, and will have to be implemented through Magento. Seller is able to to specify a handling charge for all shipments in the configuration panel/ 'Calculate Handling Fee' allows seller to choose between: Fixed: A flat handling charge applied to the shipment. When this option is selected the value specified in the 'Handling Fee' field is taken as a dollar figure, i.e. Handling Fee = 2.5 --> A handling fee of $2.50 will be added to the total order/each package (based on the option specified in 'Handling Applied') Percentage A variable handling charge applied to the total value of the shipment, either pre or post tax depending on the setup in the Magento tax module.

Handling Applied

'Handling Applied' (only applicable when seller sets 'Calculate Handling Fee' to Fixed) allows seller to choose between: Per Order: The fixed handling fee specified in the 'Handling Fee' field applies to the entire order Per Package: The fixed handling fee specified in the 'Handling Fee' field applies to each package in the shipment.

Handling Fee

'Handling Fee' allows the seller to specify the value of the Handling fee to be applied based on the method specified in the 'Calculate Handling Fee' field. If Calculate Handling Fee = Fixed --> the 'Handling Fee' field is taken as a absolute currency figure, i.e. Handling Fee = 2.50 --> A handling fee of $2.50 will be added to the shipment/per package (depending on option selected in Handling Applied). If Calculate Handling Fee = Percentage --> the 'Handling Fee' field is taken as a percentage of the total (pre-tax) shipment value, i.e. Handling Fee = 1.50 --> A handling fee of 1.5% of the pretax sales total will be added to the shipment.

Allowed Shipping Services

Seller must be able to select the Canada Post shipping methods that the store will provide Allowed Methods will display a list of all current Canada Post shipping methods (at time of module's creation). Seller should be able to select/deselect methods as desired. Module needs to determine if product can/cannot be shipped by a particular method based on product weight/size, and present results to customer accordingly. Module is not required to determine if products can/cannot be shipped by a particular method based on contents. This is the seller’s responsibility.

Displayed Error Message

By default: We're sorry the Shipping Method you are trying to use is not available for your location. Please try again later or contact us to arrange for shipping.

Require signature for all shipments?

The ability to specify an option for signature required for parcels Please use the following logic for the Signature Required option for Seller Options: 1) A global setting in the Magento configuration panel, that allows the seller is able to specify an option for Signature required for all shipments, over a seller specified threshold value (in local currency). 2) A product attribute "Canada Post Signature Required" that allows the seller to individually set products to require a signature. If a product with "Canada Post Signature Required = Yes" is part of a shipment, then the shipment requires a signature. 3) A customer should also be allowed to specify option for signature required (through Check box, on Quote and Checkout), even if neither of the above conditions are met. This is part of the Magento module requirements request. Priority Rules are as follows: If any one of the global setting/product attribute/customer option is set to 'Yes' then signature is required Only if all are 'No' then Signature Required = No

Global Setting	Product Attribute	Customer Option	Signature Required?
Y			Y
	Y		Y
		Y	Y
N	N	N	N

Lead time in days for actual processing date

Seller must be able to add a lead time to all deliveries, to be specified in number of days. Field will only accept positive integers. The value specified in the field applies to all shipping options from Canada Post, and must be added to results returned from Canada Post for all shipping options  

Date format for delivery date display

Here you can select different formats from YYYY-MM-DD to dates including seconds.

Hide estimated delivery date for all shipments?

Seller is able to hide the "Expected Delivery Date" from the buyer, for shipments with backordered products. This is intended for users whose backorder fulfillment date is either unknown or varies greatly between products (e.g. 1 day to 6 months depending on the item for sellers like Tao) This will be achieved through a toggle field (Yes, No) in the module configuration panel. Set Canada Post preferred language to current Store Language?

Quote type

Counter: Will return the regular price paid by retail customers Commercial: Will return the contracted price between Canada Post and the contract holder

Ship to Applicable Countries

In the first field 'Ship to applicable countries' seller is presented with 2 options: 1) All Allowed Countries 2) Specific Countries Selecting 'Allowed Countries' lets the seller show all countries that are already selected in Configuration>General>Allow Countries Selecting 'Specific Countries' activates the options in the 'Ship to Specific Countries' and allows the user to pick from the list of countries selected.

Ship to Specific Countries

Note: Countries that are deselected will not be hidden in the list of countries on the Front End. This is done by changing the global list in system configuration 'Countries Options'. However, if a country is deselected in the Canada Post Module, then the module will not return any shipping quotes/options.

Insurance Coverage

Always: The shipping quote request only returns quotes with the cost of coverage included, if value of shipment exceeds the threshold value Optional: The shipping quote request returns 2 quotes - one with full coverage and one without (either $0 or $100 depending on shipping method). The customer has the option of selecting coverage. (If seller does not want to assume liability for damaged/lost shipments.) Never: The shipping quote request only returns quotes with the default coverage provided (either $0 for regular, or $100 for Expedited, XpressPost and Priority Shipments)

Coverage Treshold

1) Maximum coverage allowed by CP is $5000.00 CAD 2) By default $100 of coverage is included by CP for Expedited, XpressPost and Priority Shipments. Regular parcel has $0 coverage included. Customer Options: 3) If Seller selects "Optional" then the customer is presented with a check-box (in Cart>Shipping Quote and Checkout) that allows Customer to choose Insurance. Requires customer to "Update Quote" before shipping quote is updated. This is part of the Magento module requirements request.  

Delivered to Post Office

Buyer is able to choose between having their parcel delivered to their address or 'Delivered to Post Office'. 1) Enable/disable the 'Delivered to Post Office' functionality through dropdown/checkbox in the Magento Admin Panel 2) set the max. number of Post Offices to return (Canada Post default = 10, max = 50) (if less than max are found, only those will be returned, usually for Rural)

Card for Pick Up

The buyer is able to select the 'Card for Pickup' option if the seller displays it on the front end. A Delivery Notice Card will be left for the addressee and the item will then be forwarded to the designated post office. The addressee or his representative is required to show one valid piece of government-issued photo identification when picking up the item. This option is ideal for shipments containing temperature-sensitive items. In the Magento Configuration Panel, the Seller is able to choose whether to display the 'Card for Pickup' option or not. If the Seller sets the Allow 'Card for Pickup' option to 'Yes' in the Magento Configuration panel, then a checkbox is displayed on the Front End at checkout (in the same location as the other delivery options).

Leave at Door

The buyer is able to select the 'Leave at Door' option if the seller chooses to display it on the front end. This option is only available for items that are usually delivered to the door. If no one answers the door, the delivery agent will look for an appropriate safe drop location. A Safe Drop Card, indicating the location of the safe drop, will be left in the addressee’s mail receptacle. If Safe Drop is not possible, a Delivery Notice Card will be left, and the item will be available for pickup at the designated post office. In the Magento Configuration Panel, the Seller is able to choose whether to display the 'Leave at Door' option or not.

Allow “Do not Safe Drop

”The buyer is able to select the 'Do Not Safe Drop' option if the seller displays it on the front end. This option changes the delivery process only for items that are usually delivered to the door. A delivery attempt will be made at the door and, if no one is available to receive the item, the item will not be safe dropped. A Delivery Notice Card will be left, and the addressee will be able to pick up the item at the designated post office. In the Magento Configuration Panel, the Seller is able to choose whether to display the 'Do Not Safe Drop' option or not.

Max Weight (kg)

If the total weight of the cart exceeds 30kgs, we take off the heaviest item, and check the remaining weight. If the cart items less the heaviest still exceeds 30kgs, repeat. As you do this we create an array of items that are shippable and we will then use this array to query canada post for rates on each element of the array and present the end user with the sum total of these quoted amounts. If any single item exceeds 30KGS (or whatever the setting is) then we must not allow shipment via canada post. We’ve created a CP Max Weight attribute in the admin section and auto set it for 30kgs.

Output format

For a contract shipment sellers have the option of printing labels on either Thermal Paper or Regular Paper. This option should be selectable via dropdown in the module's configuration panel.  

Manifests

"Note: This last step takes place for Contract Customers only. Non-Contract customers cannot make the "Transmit Shipments" call. The advantage of this system, is that it allows Non-Contract Shippers to make use of the grouping and categorizing features of the Manifest, as well as decrease the complexity involved when a customer switches from Non-Contract to Contract Shipping."
When seller creates a "Shipment", we create a Magento shipment, NOT a Canada Post Shipment When a seller "adds a Manifest", we create a Magento Manifest as an empty container with a Group ID. We DO NOT create an actual Canada Post Manifest. When the seller "adds the (Magento) Shipment" to a Magento Manifest, we create the Canada Post Shipment with the Group ID assigned to it from the Manifest, and get the tracking information, labels etc. If a seller "removes the (Magento) Shipment" from the Magento Manifest, we make a "Void Shipment" call to Canada Post, to cancel the Shipment. If the seller "adds the Shipment" to another manifest, we create the shipment again, but with the new manifest's Group ID When the seller "transmits the Manifest", this is when we create the Canada Post Manifest and with the assignedCanada Post Shipments (sharing the Group ID).
Note: This last step takes place for Contract Customers only. Non-Contract customers cannot make the "Transmit Shipments" call
The advantage of this system, is that it allows Non-Contract Shippers to make use of the grouping and categorizing features of the Manifest, as well as decrease the complexity involved when a customer switches from Non-Contract to Contract Shipping.  

Returns

A Return Label can be accessed and printed by the customer for a "completed" shipment from the customer's account page.   1) For Guest Checkout customers: In the Shipments > [Shipment Detail] panel, once the Canada Post shipment has been created, a button will be available for the admin to click - "Send Return Label". Clicking this will create an Authorized Shipping Label. A link to the label will be emailed to the client. Clicking on the link will display a pdf of the label. If the link returns a 404, a message should be displayed. This message can be configured by the store owner in the admin panel. Once the label is created, the tracking number from the label should be added to the Tracking list for the shipment. 2) For customers with an account In the Shipments > [Shipment Detail] panel, once the Canada Post shipment has been created, a button will be available for the admin to click - "Send Return Label". The Return Label can be accessed from both the link in email similar to one for Guest Checkout as well as above and through a link on their My Account panel. (see screenshot below)

New Canada Post Attributes

1) Attribute called "Canada Post Proof of Age Required". The options for the attribute are None (default), 18+, 19+, and 18+ or 19+ by province. If the shipment contains a product that has the "Canada Post Proof of Age" attribute set to either "18+", or "19+", the entire shipment is marked with the option code, when the request is sent to CP 2) A product attribute "Canada Post Signature Required" that allows the seller to individually set products to require a signature. If a product with "Canada Post Signature Required = Yes" is part of a shipment, then the shipment requires a signature. For paid installation support feel free to email or call us. Collins Harper