Installation Instructions

Check with web host

Ensure your web host provider has port 30,000 open. This port is used to communicate with the canada posts website and is the only port that they allow you to post data to.

Pre installation instructions

First you need to contact canada post shipping
  1. By calling the Commercial Service Network @1-800-260-7678 (and press 1 then 0) and explain to them that “you are a business and need a Canada Post Customer Number so you can get a ‘sell online account’ “ and they should sign you up
  2. Once you get that information then you need a sellonline account (oh isnt this efficient !) call 1-866-511-0546 (options 1 - 2 - 2) to create a new account they will ask you for the main contact, company name, postal code, customer number. (The customer number is the CPC number)
  3. Then you need to add your box sizes and weights to the sellonline.canadapost.ca inventory.
    Logon to sellonline.canadapost.ca using the provided account information and enter your boxes. Be sure to change your password
  4. Now add 3 attributes to the default attribute set “package_width” “package_height” “package_depth” (required integer should be in centimeters! )
  5. (Optional) Add another attribute "package_ready_to_ship" Input type should be Yes/No
  6. Add all these attributes to the default attribute set (You may also apply them to existing attribute sets)
  7. Enter values for all products (except your configurable products) you can add to the cart , your weight may be in a different weight unit of measure but it must be convertable to kilograms (To enter the conversion factor see module configuration section).

Modifications to template files

In order to use the Show shipment details functionality, you may need to modify the css file in the skin/frontend/YOURTEMPLATE/css/boxes.css to have the following, (it may already be there so search first)
.truncated { cursor:help; }
.truncated a.dots { cursor:help; text-decoration:none !important; }
.truncated a.details { cursor:help; text-decoration:none !important; display:inline-block; border-bottom:1px #1e7ec8 dotted; }
.truncated .truncated_full_value { position:relative; z-index:999; }
.truncated .truncated_full_value dl { position:absolute; top:-99999em; z-index:999; width:250px; padding:8px; border:1px solid #ccc; border-bottom-color:#bbb; border-right-color:#bbb; background-color:#f6f6f6; }
.truncated .truncated_full_value dl dt { margin-top:0; }
.truncated .show dl { top:-20px; left:50%; }
.col-left .truncated .show dl { left:35px; top:10px; }
.col-right .truncated .show dl  { left:-240px; top:10px; }

Core modifications

These modifications are neccesary ONLY if you use the Show shipment details option in the configuration

Version 1.1.6 - 1.4.0.1 template changes

The templates have been updated again in this version, this causes a the shipping details to not appear in the front and admin sections, here is the list of templates to update

app/design/frontend/default/default/template/checkout/cart/shipping.phtml Lines ~68-70

<input name="estimate_method" type="radio" value="<?php echo $this->htmlEscape($_rate->getCode()) ?>" id="s_method_<?php echo $_rate->getCode() ?>"<?php if($_rate->getCode()===$this->getAddressShippingMethod()) echo ' checked="checked"' ?> />
<label for="s_method_<?php echo $_rate->getCode() ?>"><?php echo $_rate->getMethodTitle() ?>
<strong><?php echo $_rate->getMethodDescription() ?>
app/design/adminhtml/default/default/template/sales/order/create/shipping/method/form.phtmlLine ~44

OLD
<?php echo $_rate->getMethodTitle() ? $_rate->getMethodTitle() : $_rate->getMethodDescription()?> -
NEW
<?php echo $_rate->getMethodTitle() . ' ' . $_rate->getMethodDescription()?> -

Version 1.1.4 to version 1.1.6

The containers for the shipping description are (in some spots) only 255 characters - this causes the data retrieved from canada post to be truncated. The following sql code corrects it and should be run against the database magento is pointing to. Note: please backup database before performing the changes so you can roll back if neccesary.

UPDATE eav_attribute ea join
       eav_entity_type et
       on ea.entity_type_id = et.entity_type_id
set backend_type='text'
where ea.attribute_code='shipping_description' and et.entity_type_code='order';
ALTER TABLE `sales_flat_quote_address`
CHANGE `shipping_description`
`shipping_description` TEXT NOT NULL;

Version 1.1.4

The following patch is only applicable to version 1.1.4 - it has been corrected in version 1.1.6

app/core/Mage/Sales/Model/Quote/Address/Rate.php Around Line 62
                ->setCode($rate->getCarrier().'_'.$rate->getMethod())
                ->setCarrier($rate->getCarrier())
                ->setCarrierTitle($rate->getCarrierTitle())
                ->setMethod($rate->getMethod())
                ->setMethodTitle($rate->getMethodTitle()) // New
                ->setMethodDescription($rate->getMethodDescription()) // Changed
                ->setPrice($rate->getPrice())