🇨🇦 ShipStation API Carriers Canada

For Canada-based ShipStation API accounts, you have immediate access to Canada Post, GlobalPost, and FedEx shipping labels with ShipStation API Carriers. There’s no need to create and connect individual carrier accounts. Activate ShipStation API Carriers by adding the billing method you wish to use to purchase your labels and add funds to your ShipStation API Balance.

Requirements

  • Activate ShipStation API Carriers in your ShipStation API Account (steps included in the following section)

  • Add funds to your ShipStation API Balance

    You can add funds using ShipStation API’s add_funds endpoint, which must first be enabled by the ShipStation API Support team. If you'd like to add funds via this endpoint, please submit a request to our support team.

Activate ShipStation API Carriers

To start using ShipStation API Carriers, you must activate it by adding the payment method you wish to use for your labels. Log in to ShipStation API and do the following:

You will now see your available carriers under Setup > Carriers, where you can also find their unique Carrier IDs. You can also make a List Carriers call to view all of your Carrier IDs and available services.

Setup_Carriers_CAEngineCarriers.png

Be sure to also add funds to your ShipStation API Balance so you can start purchasing your labels!

Connecting Your Own Carrier Accounts

You can also connect your own carrier accounts through the My Carrier Accounts section of the Carriers settings page.

Available Features for Canada ShipStation API Carriers

Canada ShipStation API Carriers support the following standard features:

Common Features

Feature

Canada Post from ShipStation API

GlobalPost from ShipStation API

Purolator from ShipStation

Domestic Shipping

Green checkmark. Supported feature. Yes.

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

International Shipping

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Red X mark. Unsupported feature. No.

Electronic Customs Submission*

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

Grey dash icon. Not applicable.

Return Labels

Green checkmark. Supported feature. Yes.

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

Estimated Rates

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Tracking

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Green checkmark. Supported feature. Yes.

Label Branding

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

Label Messages

Green checkmark. Supported feature. Yes.

Red X mark. Unsupported feature. No.

Green checkmark. Supported feature. Yes.

Multi-package Shipping

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

Red X mark. Unsupported feature. No.

The carrier can be used to create domestic shipping labels.

The carrier can be used to create international shipping labels.

ShipStation API will submit international customs declarations electronically to the carrier.

The carrier can be used to create domestic return labels.

When an API call is made to the Rates endpoint, ShipEngine will return estimated shipping rates for the carrier based on the connected account information and shipment details.

Shipping labels created for this carrier will include a tracking number that can be used to view the shipment status on the carrier's tracking website. Tracking may not be available for all shipping services.

ShipEngine can print your brand logo on shipping labels from carriers that support this feature. Add your logo in the ShipEngine Dashboard.

ShipEngine can include additional information on a shipping label that is specified in the label request, if supported by the carrier.

This carrier can be used to create multi-package shipments, where multiple labels are created for a single shipment and the individual packages are linked together in a single shipment record with a master tracking number.

The carrier can be used to create domestic shipping labels.

The carrier can be used to create international shipping labels.

ShipStation API will submit international customs declarations electronically to the carrier.

The carrier can be used to create domestic return labels.

When an API call is made to the Rates endpoint, ShipEngine will return estimated shipping rates for the carrier based on the connected account information and shipment details.

Shipping labels created for this carrier will include a tracking number that can be used to view the shipment status on the carrier's tracking website. Tracking may not be available for all shipping services.

ShipEngine can print your brand logo on shipping labels from carriers that support this feature. Add your logo in the ShipEngine Dashboard.

ShipEngine can include additional information on a shipping label that is specified in the label request, if supported by the carrier.

This carrier can be used to create multi-package shipments, where multiple labels are created for a single shipment and the individual packages are linked together in a single shipment record with a master tracking number.

Available Services

Click to view the available services for ShipStation API Carriers.

Canada Post from ShipEngine Services

Canada Post Service Details

The following table provides further details about Canada Post services:

Service

Description

Paperless Labels Support

You can request a paperless label download link instead of a label PDF when creating a label. Add the display_scheme property to your call with the value paperless or label_and_paperless. You can then email the paperless label to be used when dropping off the package with the carrier.

  • Priority

  • Xpresspost

  • Expedited Parcel (Carbon Neutral)

  • Regular Parcel (Carbon Neutral)

GlobalPost from ShipEngine Services

GlobalPost from ShipEngine offers GlobalPost Standard International only.

Not Available for Netsuite and GoDaddy

GlobalPost Canada services are not currently available for Netsuite or GoDaddy integrations.

GlobalPost Standard Details

Here are a few additional details about the GlobalPost Standard service:

  • Max weight: Shipments sent to the US have an 11kg max, all other supported destinations have a 30 kg max.

  • Minimum dimensions: 5" x 3.5" x 0.75"

  • Maximum dimensions: Max Length (the longest side) is 24"; Length + Width + Height cannot exceed 36"

  • Tracking: Door to door

  • Maximum value of goods: varies by country (up to $2500 USD)

  • Default loss/damage coverage: up to $100 against loss or damage + shipping costs

  • Duties & taxes: paid by recipient (DDU)

  • Additional fees: fuel surcharge

Purolator from ShipStation Available Services

Available Services & Package Types

Purolator Domestic Services

  • Purolator Express 9 AM

  • Purolator Express 10:30 AM

  • Purolator Express

  • Purolator Express Evening

  • Purolator Ground

  • Purolator Ground 9 AM

  • Purolator Ground 10:30 AM

  • Purolator Ground Evening

Purolator Package Types

  • Package

    ShipStation API users: You must use the packageCode customerpackage with this carrier.

Additional Features for Purolator from ShipStation API

Purolator from ShipStation API allows for the following additional features:

Feature

Description

Void Labels

You can void the Purolator from ShipStation API labels, at any time and on any day, after label creation and before the Purolator has scanned the shipment. Purolator will only charge for the label after the shipment’s first scan.

File a Claim for lost or damaged shipments.

You can file a claim for lost or damaged shipments with Purlator using the Purolator Claim form or their Virtual Assistant.

You can submit a claim without an account number by using an asterisk * in the form's account number field.

Schedule a Pickup

You can now schedule Purolator pickups directly in ShipStation using the in app pickup scheduler.

If needed, you can also cancel a previously scheduled pickup in ShipStation.

Obtain a Purolator Activation Key

  1. Visit the Purolator Developer's API Portal.

  2. Click Register and log in to Purolator.

  3. Go to the API Portal on the MyPurolator home page.

    Shows the API Portal button marked on the My-Purolator homepage.
  4. Click Activation Keys on the API Portal dashboard. Then click Request Activation Key.

    My-Purolator API Portal. Shows the Activation Keys & Request Activation Keys buttons
  5. Select the appropriate company from the Who is you eCommerce solution provider? drop-down menu. Then click Next.

    Purolator Activation-Keys request page. Shows e-Com-SOLUTION-PROVIDER menu & Next button
  6. Complete the Purolator Business Account information as requested, then click Next.

    Account Number requires a minimum of 7 digits

    Purolator Business Account Numbers require 7 or more digits. If your account has fewer than 7 digits, please add any necessary preceding 0s. 

    For example, for Account 123, you would need to add four additional 0s so it reads 0000123.

    Request Activation Key. Shows the Purolator Business Account info fields & Next button
  7. Complete the fields for Where will your Purolator shipments be originating from?, then accept the Terms and Agreements and click Next.

    Include Three Company Contacts

    This page will ask you to include three company contacts. This way if you transition away, your company can still process shipments without you.

    Request Activation Key. Shows the Purolator Shipments Origin info fields & Next button
  8. Click Copy Key and store the key in a safe, secure place.

    Once completed, the key will show on screen and be available for your API Management.

    Request Activation Key. Shows the Copy-Key button.

    Purolator system-generated passwords

    Some ecommerce partners require a password that the Purolator system generates. It will be different than your login password for the Purolator websites.

  9. Check your email. You should have a Purolator confirmation email from notificationservice@purolator.com. Click the link within the email to open a page to Obtain an Activation Key.

  10. Open a new tab or window and log in to your ShipStation API account.

The carrier can be used to create domestic shipping labels.

The carrier can be used to create international shipping labels.

ShipStation API will submit international customs declarations electronically to the carrier.

The carrier can be used to create domestic return labels.

When an API call is made to the Rates endpoint, ShipEngine will return estimated shipping rates for the carrier based on the connected account information and shipment details.

Shipping labels created for this carrier will include a tracking number that can be used to view the shipment status on the carrier's tracking website. Tracking may not be available for all shipping services.

ShipEngine can print your brand logo on shipping labels from carriers that support this feature. Add your logo in the ShipEngine Dashboard.

ShipEngine can include additional information on a shipping label that is specified in the label request, if supported by the carrier.

This carrier can be used to create multi-package shipments, where multiple labels are created for a single shipment and the individual packages are linked together in a single shipment record with a master tracking number.