How to add CanadaPost as an integrated carrier in Auctiva Commerce

Auctiva Commerce will integrate with CanadaPost to provide its unique shipping services with accurate shipping charges for your customers at checkout. This tutorial will show you how to configure CanadaPost in Auctiva Commerce.

How to add CanadaPost

It's important to consider the shipping parameters (i.e., warehouses, shipping zones and user groups) associated with this shipping method in advance to adding the integrated carrier. As soon as shipping services are added from this integrated carrier, it becomes instantly available to all warehouses, all shipping zones and all user groups by default. You will need to quickly edit each shipping service to define these parameters. Otherwise, an order could be made that is not intended to be shipped by this method. The safest way to add a new integrated carrier is to enable the Suspend Purchasing mode (Store> Configure> Store Settings). Enabling this mode will hide all the "Add to Cart" buttons. Once you edit the shipping methods so that they have the correct parameters, you can disable the Suspend Purchasing mode to resume ordering on your store.

If an order is eligible for an integrated shipping service, the integrated carrier checks the customer's order information (i.e., shipment weight, shipment dimensions and origin/destination addresses) to assess an estimated shipping charge. Most often, the carrier uses only the Zip Code and not the entire address to compute the estimated charge. The actual shipping charge may slightly vary due to fuel surcharges and other fees when you create the actual delivery using the exact origin and destination addresses that the carrier requires to make the shipment. If this becomes a problem, you can consider adding a small handling fee to each integrated shipping method to help cover the spread between estimated shipping charges and actual shipping charges.

Step 1. Register with CanadaPost.
  • Contact CanadaPost to register for an account. You will need CanadaPost Merchant CPC ID. See CanadaPost for more information.
Step 2. Add CanadaPost as an integrated carrier.

Note: You can use the Integrated Shipping Carriers wizard in the Welcome box on the Dashboard in administration. Otherwise, follow these detail instructions:

  • Go to Store> Shipping> Integrated Carriers.
  • Click the Add Carrier button. The Shipping Carriers box will load.
  • Click on the CanadaPost option. The CanadaPost Activation page will load.
  • Gateway Name: Enter in the name of the gateway. This is for administration purposes only.
  • CanadaPost Merchant CPC ID: Enter in your CanadaPost User ID. This ID will have a unique format which looks like "CPC_XXXXXXXX." The CPC ID is not the same as your CanadaPost account number.
  • Click the Register button.
  • Check the "Activated" box and click the Next button. The CanadaPost Configuration page will load.
Step 3. Configure CanadaPost.
  • Enable Package Breakup: Enable Package Breakup if desired. Enabling it means that you will allow the carrier to divide a shipment into smaller packages if the shipment exceeds the weight maximum. It does not create additional shipments for you. It only divides the total shipping weight by the necessary amount so that an acceptable shipping weight can be calculated by the integrated carrier for this particular order. In the end, the calculation will only return one rate based on the individual shipping weights that were calculated by the carrier. The customer will only see one shipping charge.
  • Do not edit the Leave Live, Test and Tracking URLs. These come pre-configured when you create a shipping account through Auctiva Commerce.
  • Debug Mode: When debug mode is enabled, all messages sent to and received from CanadaPost are logged. This should only be enabled at the direction of qualified support personnel.
  • Click the Update button.
Step 4. Configure CanadaPost shipping methods.

It's highly recommended that you enable the Suspend Purchasing mode if you haven't done so already. This next step will add services to your store. By default, it will make the shipping services available to all warehouses, shipping zones, and user groups. This means you could get an order that uses a shipping service not intended for that type of order in the time it takes to edit each service.

  • Click on the "Services (Shipping Methods)" tab at the top of the Configure CanadaPost page.
  • In the "Provider Services Not Configured" section, choose which services you want to provide by checking each box next to the desired service.
  • Click the Add Default Configuration button. The chosen services will now be loaded into the "Provider Services Configured" section and they are officially live on your store.
Step 5. Customize your shipping service.

Now you're ready to customize each of the shipping services.

  • Click on the Edit icon for a shipping service you just added. Each shipping service you added in Step 4 will need to be individually edited.
  • Name: Enter in the name of the shipping method. This name will appear on your store at checkout.
  • Service: Do not change this option. By default the service selected in Step 4 is automatically assigned to this shipping method.
  • Handling Fee: Enter in any handling fees to be added to the shipping charges. Choose whether the handling fee is a Fixed Amount or Percent. The Fixed Amount will be the value you enter into this field and the Percent amount will take that percentage from the order amount to create the handling fee charge.
  • Choose how you want the handling fee to show if there is a handling fee.
  • Warehouses: Choose which warehouses that will be assigned to this shipping method. Choosing the All Warehouses option will apply this shipping method to every product in your store.
  • Zones: Choose which shipping zones will be assigned to this shipping method. Choosing the All Zones option will allow customers in every shipping zone that you've created to receive shipments by this shipping method.
  • Groups: Choose which user groups will be assigned to this shipping method. Choosing the All Groups option will allow all customers with eligible orders and shipping addresses to use this shipping method.
  • Minimum Purchase: Enter in the minimum purchase value that a customer needs to spend on their order to be eligible for this method. Leave this field blank if there is no minimum purchase required.
  • Tax Code: Choose a tax code option if you wish to assess taxes on the shipping charge. Don't choose a tax code if no taxes should be assessed on the shipping charge.
  • Click the Save button. This will take you to the Configure Shipping Methods page, where all your shipping methods are displayed. Continue to repeat Step 5 for all the services you've added until each is properly set up.

Remember to disable the Suspend Purchasing mode if you're ready to start taking orders. Otherwise, keep it enabled as you set up additional critical store features.

This completes the task of integrating CanadaPost into Auctiva Commerce. It's a good idea to check your storefront to make sure the CanadaPost Shipping Methods do appear where you expect to find them.

Was this tutorial helpful? Tell us what you think in this quick survey. Your feedback is highly valued. Thank you.


◄ Back to Help

Customer Support

If you have been unable to find the answer you were looking for using our Help documentation, please file a customer support request. We have customer support professionals ready to help you 24 hours a day, Monday - Friday (excluding major holidays.)