Canada Post - Sell Online Developer's Site
Implementation Instructions for the Sell Online Shipping Module
Standard XML version
Sell Online Solutions can be found by visiting our home page.
Feature: Standard Features
The consumer will be given the choice of delivery speeds.
Your consumer can be offered a choice of shipping costs and delivery dates.
The Sell Online application will return a list of choices for the consumer. The Sell Online application will select
a box from the list of boxes in the merchant's shipping profile to minimize the size of the box used for shipping and
this will ensure the lowest shipping cost is calculated. The box description should be passed to the person packing the
- Parcel shipping cost can be the choice of the consumer.
- Actual shipping cost can be calculated to remove the risk for the merchant.
- Accurate delivery dates can be given to the consumer.
Development team please follow these instructions.
- The commerce application being used by your store will have to change.
Can you change the application code?
- Request a shipping profile account from firstname.lastname@example.org
- Sample transaction from Browser (http://sellonline.canadapost.ca/DevelopersResources/protocolV3/HTTPInterface.html)
- Our recommended communication method is an HTTP Post with XML.
- Build the script in your commerce application to provide the needed data for the HTTP Post.
Pickup the DTD from (http://sellonline.canadapost.ca/DevelopersResources/protocolV3/eParcel.dtd)
Post the form to the Sell Online server, receive response from Sell Online
Parse the results from XML for display to the consumer
- CPC Id
- Destination: Country, Postal Code
- Size and weight of each item.
- Size and weight units of measurement are centimeters and kilograms.
Capture the consumer selection and pass the information returned by Sell Online to the group preparing the
parcels for shipment.
Identify the box selection to the parcel preparation group.
Print Shipping label with the shipping speed choosen.
Test the integration for each of the possible results including the error messages.
See Developers site for test cases.(http://sellonline.canadapost.ca/DevelopersResources/)
Note for Developers:
- We recommend the use of XML and an XML parser to isolate the commerce engine from the evolutionary changes of
the Sell Online application
- An HTML message can be returned from the Sell Online server. This method will not provide as good an
isolation from the Sell Online changes.
- The values returned are in Canadian dollars, if you need to display another currency value
you will need to develop a program to convert the currency before displaying to the consumer.
- To use HTML request the Sell Online support to change the profile from email@example.com
- The server is responding between 300 to 600 milliseconds.
- We have found some of our clients are experiencing delays up to 10 second to 30 seconds. If you are have these types of delays
the following could be a few areas that are causing the delays:
- Number of items that you are asking to be packed. Sell Online is optimized to handle 1 to 5 items per purchase.
More then 30 to 50 items could cause slow response times.
- The number of boxes that listed in the shipping profile.
- The HTTP connection to the server might have a wait state in your code to shut the connection to the Sell Online server
before you display the results.
- The network connection might be slow or your firewall could be slow and not giving a high priority to the transaction.
- If you are using an XML parser, this could cause a delay. During client implementations we have had feedback
that the parser could be installed with a wait state. This is usually configurable and can be removed. The cases that we found were waiting for 30 seconds.