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.
-
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.
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.
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.
Canada ShipStation API Carriers support the following standard features:
|
Feature |
Canada Post from ShipStation API |
GlobalPost from ShipStation API |
Purolator from ShipStation |
FedEx from ShipStation API |
|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For most countries, the data passes electronically to FedEx (ETD). Where ETD is not supported, the invoice needs to be printed. See Available Services. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Click to view the available services for ShipStation API Carriers.
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
|
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.
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 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
customerpackagewith this carrier.
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. |
-
Visit the Purolator Developer's API Portal.
-
Click Register and log in to Purolator.
-
Go to the API Portal on the MyPurolator home page.
-
Click Activation Keys on the API Portal dashboard. Then click Request Activation Key.
-
Select the appropriate company from the Who is you eCommerce solution provider? drop-down menu. Then click Next.
-
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.
-
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.
-
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.
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.
-
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.
-
Open a new tab or window and log in to your ShipStation API account.
FedEx Domestic Services
|
Shipping Service |
Carrier Code |
API Code |
|---|---|---|
|
FedEx Ground® |
FEDEX_GROUND |
|
|
FedEx Economy |
FEDEX_EXPRESS_SAVER |
|
|
FedEx 2Day® |
FEDEX_2_DAY |
|
|
FedEx Standard Overnight® |
STANDARD_OVERNIGHT |
|
|
FedEx Priority Overnight® |
PRIORITY_OVERNIGHT |
|
|
FedEx First Overnight® |
FIRST_OVERNIGHT |
|
FedEx International Services
|
Shipping Service |
Carrier Code |
API Code |
|---|---|---|
|
FedEx International Economy® |
INTERNATIONAL_ECONOMY |
|
|
FedEx International Ground® |
FEDEX_GROUND |
|
|
FedEx International First® |
INTERNATIONAL_FIRST |
|
|
FedEx International Priority® |
FEDEX_INTERNATIONAL_PRIORITY |
|
|
FedEx International Priority® Express |
FEDEX_INTERNATIONAL_PRIORITY_EXPRESS |
|
|
FedEx International Connect Plus® |
FEDEX_INTERNATIONAL_CONNECT_PLUS |
|
FedEx Package Types
|
Name |
Carrier Packaging Code |
API Code |
|---|---|---|
|
FedEx® Box |
FEDEX_BOX |
|
|
FedEx® Envelope |
FEDEX_ENVELOPE |
|
|
FedEx® Pak |
FEDEX_PAK |
|
|
FedEx® Tube |
FEDEX_TUBE |
|
|
FedEx® 10kg |
FEDEX_10KG_BOX |
|
|
FedEx® 25kg |
FEDEX_25KG_BOX |
|
|
FedEx® Small Box |
FEDEX_SMALL_BOX |
|
|
FedEx® Medium Box |
FEDEX_MEDIUM_BOX |
|
|
FedEx® Large Box |
FEDEX_LARGE_BOX |
|
|
FedEx® Extra Large Box |
FEDEX_EXTRA_LARGE_BOX |
|
|
Package |
YOUR_PACKAGING |
|
A Fedex from ShipStation API shipment can be returned to sender. To reroute or redirect an in-transit shipment, go to this link and follow the provided instructions: .
Select the option to Reroute my Fedex from ShipStation API package and fill in the required information.
Reroute Fee
-
Fedex may charge a fee for rerouting shipments, by submitting your request, you agree to any carrier assessed charges. Any fees incurred will be deducted from your ShipStation API balance.
A few things to keep in mind when rerouting a package:
-
Shipments out for delivery may not be eligible for delivery intercept.
-
Eligibility is determined by the carrier.
-
This is not a guaranteed service, so It is important to file this claim as soon as possible
-
Pickup/Dropoff (PUDO) is not supported with FedEx from ShipStation.
-
Pickups: FedEx from ShipStation API does not support pickups.
-
DDP: FedEx from ShipStation API does not support DDP. FedEx supports DDP with direct integrations only.
-
Do Not Overstuff Boxes: All items must fit in a FedEx One Rate box so it seals neatly and without changing the box’s shape or dimensions. Please use a larger box if the items do not fit.
Any overstuffed box will incur adjustment charges.
-
Ordering Supplies is not supported through FedEx from ShipStation API
-
Fuel Charge Discrepancies: For most services, FedEx includes a fuel charge as part of the label cost. FedEx updates this cost weekly, depending on the fuel prices at the time of label purchase. Occasionally, there are discrepancies between the calculated fuel-price rate and what FedEx charged at the time of label purchase.
If the fuel-charge amount differs from what was charged to the merchant, ShipStation will adjust the amount (charged or refunded) for the merchant when we receive the FedEx invoice.
To avoid fuel charge discrepancies, please consider using a FedEx service that does not apply a fuel charge:
-
All FedEx One Rate services
-
FedEx International Connect Plus
-
-
🇨🇦 For Canada-based accounts, FedEx from ShipStation does not support Money Back Guarantee (MBG) for shipping services.
-
ShipStation does not charge taxes for shipments using FedEx from ShipStation.
-
FedEx from ShipStation API does not support third-party billing.
-
Adjustments for Package and Weight Dimensions: During shipping, overhead scanners and scales automatically verify package dimensions and weight. If there are differences from the initial information provided, adjustment charges may occur.
For size discrepancies, carriers typically require a drop-off receipt or significant evidence to consider dispute claims. Adjustment dispute resolutions are ultimately decided by the carrier. Review individual carrier terms of service for additional details.
-
Adjustment requests for Express shipments (domestic and international) must be submitted within 50 days,
-
Adjustment requests for Ground shipments must be submitted within 160 days.
-
-
Duties and Taxes Adjustment: DDP (billing duties and taxes to the payor of the shipping charges) is not supported.
-
Restricted Items: FedEx from ShipStation does not support shipping alcohol, dry ice, tobacco, firearms, live animals, dangerous goods, or other items or commodities that may be prohibited by the FedEx Service Guide or by law. Such commodities require a separate agreement.
-
COD (Collect on Delivery) and scheduling pickups are not available.
-
Electronic Trade Documents (ETD): For the countries listed here, customs data are passed to FedEx electronically and there is no need to print the customs forms.
For countries not listed, please print the customs documentation (returned with the call for API users) and attach it to the shipment.
*ShipStation will not support ETD for all countries where FedEx supports ETD. We can only support it with countries that do not require a letterhead.
-
Austria, Australia, Belgium, Bahrain, Canada, Switzerland, Côte d'Ivoire (Ivory Coast), Germany, Denmark, Finland, Micronesia, Federated States of France, United Kingdom, Croatia, Ireland, Japan, Liechtenstein, Sri Lanka, Luxembourg, Monaco, Marshall Islands, Macau, Northern Mariana Islands, Mexico, Netherlands (Holland), Poland, Puerto Rico, Palestinian Territory, Occupied Palau, Saudi Arabia, Sweden, Slovenia, Slovak Republic (Slovakia), San Marino, Togo, Tunisia, Holy See (Vatican City State).
-
-
Error Message: Alert on FedEx Tracking Page - “Clearance instructions from the importer are required.“
-
This can occur if certain customs information (like the EORI or HS codes) is not included when the shipment is processed. In this situation, the shipment is held up at customs due to the missing information. Contact support if you see this error.
-
