Site Logo

🎉 ShipEngine is becoming ShipStation API 🎉

Over the next few months you'll notice the ShipEngine website, documentation portal, and dashboard being rebranded as ShipStation API. For our ShipEngine customers, you don't need to take any action or change any of your integrations in any way. All endpoints will remain the same and continue to function as they always have.

To learn more about what's coming, review our New ShipStation API page.

Purolator from ShipStation

Purolator from ShipStation offers domestic and international shipping services for ShipStation API accounts based in Canada. International service provides shipping from Canada to the US only.

This guide provides developers with the details needed to build Purolator from ShipStation shipping capabilities into your ShipStation API workflows.

ShipStation API also allows you to connect your own existing Purolator Canada account and the requirements and service details are different than those for Purolator from ShipStation. For details about connecting and using your own Purolator Canada account with ShipStation API, see our Purolator Canada Guide.

Requirements

carrier_name: purolator_walleted

  • A ShipStation API account based in Canada.
  • ShipStation Carriers must be activated for the account and have a positive account balance to create labels. See our Using ShipStation Carriers page for details about activating in your account.
  • Both weight and dimensions are required for all shipments.

Rates

Purolator from ShipStation supports rate shopping with ShipStation API.

Service Details

Available Purolator from ShipStation services are provided below. Please note that carriers may update their available services at any time. To ensure you are always using valid services, you can use the list carrier services endpoint at any time.

Max weight for all services: 70lbs (32kg)

Domestic Services

ServiceAPI Code
Purolator Express 9 AMpurolator_express_9am
Purolator Express 10:30 AMpurolator_express_1030am
Purolator Expresspurolator_express
Purolator Express Eveningpurolator_express_evening
Purolator Groundpurolator_ground
Purolator Ground 9AMpurolator_ground9am
Purolator Ground 10:30AMpurolator_ground1030am
Purolator Ground Eveningpurolator_groundevening

International Services

ServiceAPI Code
Purolator Ground U.S.purolator_groundus

Return Services

Purolator from ShipStation supports creating return return labels with their domestic services.

Review the Return Shipping Labels page for details on creating return labels with ShipStation API.

Packages

The following carrier package types are available for Purolator from ShipStation services:

NameAPI CodePackage Attributes
PackagecustomerpackageInternational, Domestic

Please note, you cannot use the generic package value for the package type with Purolator shipments.

Adding Shipment Insurance

Purolator from ShipStation supports adding carrier insurance to shipments created in ShipStation API.

Purolator includes default coverage up to CAD$100. You must declare a value for the shipment to be entitled to submit a claim (max CAD$5,000). For a declared value over CAD$100, a 4.5% surcharge of the amount of the declared value will be applied to the cost of the shipment.

Claims must be submitted tot he Purolator claim submission form.

Label Support

  • Label sizes: 4" x 6", 4" x 8"
  • Label formats: PDF

Label Reference Fields

Purolator from ShipStation supports adding custom label messages.

  • Label Message 1 = Reference field 1
  • Label Message 2 = Reference field 2
  • Label Message 3 = Reference field 3

Multi-Package Labels

Purolator from ShipStation supports creating multi-package shipments.

Label Branding

Purolator from ShipStation does not support label branding.

Voiding Labels

Purolator from ShipStation supports voiding labels with ShipStation API. You must void the label before midnight ET on the day of label creation, as Purolator automatically manifests all shipments at midnight ET each day. Once manifested, a label cannot be voided.

See our Void a Label page for details about voiding labels with ShipStation API.

Paperless Labels

Purolator from ShipStation does not support paperless labels.

Customs Declarations

Customs declarations print directly on the label for the CA to US service. No additional forms need to be downloaded.

Delivery Confirmation

Confirmation TypeAPI CodeDescription
No confirmationnoneNo confirmation requested.
Origin signature not requireddeliveryDelivery confirmation is requested.
Residential signature domesticsignatureSignature is required for the shipment to be delivered. This signature may be a neighbor, building manager, or the recipient can authorize the release of the package (without being present).

See our Delivery Confirmation page for more details about using the confirmation property.

Advanced Options

Purolator from ShipStation supports certain advanced options, which you can add to the shipment object when creating a shipment or label.

OptionTypeDefault ValueDescription
additional_handlingbooleannullIndicates the package requires special handling.
non_machinablebooleanfalseIndicates that the package cannot be processed through sorting machines.
saturday_deliverybooleanfalseIndicates that the carrier should charge for delivery on Saturday for services that do not otherwise include saturday delivery.

To ensure you always have the most up-to-date information about a carrier's advanced options, use the list carrier options call.

Manifests

Purolator automatically manifests all shipments at midnight ET each day. You do not need to manually manifest your Purolator shipments.

Scheduling Pickups

Purolator from ShipStation supports scheduling pickups using ShipStation API. If you cancel the scheduled pickup with less than 24 hours notice, you will be charged a fee.

Service Points (PUDO)

Purolator from ShipStation does not support shipping to service points.

Tracking

Purolator from ShipStation supports receiving tracking updates. Review our ​Track a Package guides​​ for details on tracking with the ShipStation API.