CanadaPostRates Class

Properties   Methods   Events   Configuration Settings   Errors  

Provides access to pre-ship rate information for a single package per your established Canada Post account rates.

Class Name

InShip_CanadaPostRates

Procedural Interface

 inship_canadapostrates_open();
 inship_canadapostrates_close($res);
 inship_canadapostrates_register_callback($res, $id, $function);
 inship_canadapostrates_get_last_error($res);
 inship_canadapostrates_get_last_error_code($res);
 inship_canadapostrates_set($res, $id, $index, $value);
 inship_canadapostrates_get($res, $id, $index);
 inship_canadapostrates_do_config($res, $configurationstring);
 inship_canadapostrates_do_getrates($res);
 inship_canadapostrates_do_reset($res);

Remarks

When providing origin, destination information, weight, and service, this class allows a user to obtain a rate quote for a specific service.

You can send a rate request to Canada Post by calling the GetRates method for a specific Canada Post service for a single package.

If you specify a CanadaPostContractId then your account rates will be provided, otherwise the standard list rates will be returned.

When requesting a rate quote, you should give as much detail as possible to get the most accurate quote. This should include the PackageLength, PackageWidth, PackageHeight, and PackageWeight as well as any ShipmentSpecialServices you wish to use.

Once you have made a successful call to GetRates, you can retrieve all rates returned in Services.

Please note that all rate quotes are estimates and may differ from the actual invoiced amount.

In order to use this class you will need to have a CanadaPost CanadaPostAccountNumber, which is your customer number. You will also need to have signed up for the Developer Program and obtained a CanadaPostUserId and CanadaPostPassword.