# 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](/apis/shipengine/docs/carriers/purolator-canada).

## 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](/apis/shipengine/docs/carriers/setup) for details about activating in your account.
* Both weight and dimensions are required for all shipments.


#### Obtain a Purolator Activation Key

1. Visit the [Purolator Developer's API Portal](https://ship.purolator.com/developer).
2. Click **Register** and log in to Purolator.
3. Go to the **API Portal** on the MyPurolator home page. 
![API Portal on the MyPurolator home page](/assets/purolator_api-portal_activation-6.903fce6c96d0d00fa3fcd819c391a5217c40a7ee865753d1e78a8cfc04ce5316.f677354c.png)
4. Click **Activation Keys** on the API Portal dashboard. Then click **Request Activation Key**.
 ![Activation Keys on the API Portal dashboard](/assets/purolator_api-portal_activation-2.bf5f4d77929f54cdeb55b9894953c09d09b7bd6b9b81171c0df63200c756f002.f677354c.png)
5. Select **ShipStation / ShipEngine** as the appropriate company from the *Who is your eCommerce solution provider?* drop-down menu. Then click **Next**.  ![Activation Keys on the API Portal dashboard](/assets/purolator_api-portal_activation-4.0e0e3ad4b35ede65b7b7fa5bf61495e36f47ee394548b485b16e41c35c8fd169.f677354c.png))


Who is your eCommerce solution provider?_ drop-down menu

1. Complete the Purolator Business Account information as requested, then click **Next**.


> **IMPORTANT:** 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.   ![Purolator Business Account information](/assets/purolator_api-portal_activation-1.190a3b807a9fa728d56bf1cc77198ed60b0c89c0a18aadbfaf56702257cead52.f677354c.png)


1. Complete the fields for *Where will your Purolator shipments be originating from?*, then accept the Terms and Agreements and click **Next**.


> **NOTE:** 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.   ![Purolator Shipment Origin information](/assets/purolator_api-portal_activation-5.b19d7c60e168c9b08d6db833d4906c928d4ded5b250e09c352203ac79c2ac387.f677354c.png)


1. 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 Copy Key button](/assets/purolator_api-portal_activation-3.1d0bb7246e2751f8ec6722a51ee79535a42eca9b30d8978e1dc9ff81aba07126.f677354c.png)
2. 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**.
3. Open a new tab or window and [log in to your ShipStation API account](https://dashboard.shipengine.com/).


## Rates

Purolator from ShipStation supports [rate shopping](/apis/shipengine/docs/rates/rates) with ShipStation API.

## Service Details

The services available with Purolator from ShipStation appear 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](/apis/shipengine/docs/reference/list-carrier-services) endpoint at any time.

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

### Domestic Services

| Service | API Code |
|  --- | --- |
| Purolator Express 9 AM | `purolator_express_9am` |
| Purolator Express 10:30 AM | `purolator_express_1030am` |
| Purolator Express | `purolator_express` |
| Purolator Express Evening | `purolator_express_evening` |
| Purolator Ground | `purolator_ground` |
| Purolator Ground 9AM | `purolator_ground9am` |
| Purolator Ground 10:30AM | `purolator_ground1030am` |
| Purolator Ground Evening | `purolator_groundevening` |


### International Services

| Service | API Code |
|  --- | --- |
| Purolator Ground U.S. | `purolator_groundus` |


### Packages

The following [carrier package types](/apis/shipengine/docs/shipping/carrier-packaging) are available for Purolator from ShipStation services:

| Name | API Code | Package Attributes |
|  --- | --- | --- |
| Package | `customerpackage` | International, Domestic |


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

### Return Services

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

Review the [Return Shipping Labels page](/apis/shipengine/docs/shipping/returns) for details on creating return labels with ShipStation API.

### 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 to the [Purolator claim submission form](https://www.purolator.com/en/resources-support/file-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](/apis/shipengine/docs/labels/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](/apis/shipengine/docs/shipping/multi-package).

### Label Branding

Purolator from ShipStation does not support [label branding](/apis/shipengine/docs/labels/branding).

### Voiding Labels

Purolator from ShipStation supports voiding labels with ShipStation API. You can void the Purolator from ShipStation 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.

See our [Void a Label page](/apis/shipengine/docs/labels/voiding) for details about voiding labels with ShipStation API.

### Paperless Labels

Purolator from ShipStation does not support [paperless labels](/apis/shipengine/docs/labels/paperless).

### 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 Type | API Code | Description |
|  --- | --- | --- |
| No confirmation | `none` | No confirmation requested. |
| Origin signature not required | `delivery` | Delivery confirmation is requested. |
| Residential signature domestic | `signature` | Signature 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](/apis/shipengine/docs/shipping/delivery-confirmation) for more details about using the `confirmation` property.

## Advanced Options

Purolator from ShipStation supports certain [advanced options](/apis/shipengine/docs/carriers/advanced-options), which you can add to the `shipment` object when creating a shipment or label.

| Option | Type | Default Value | Description |
|  --- | --- | --- | --- |
| `additional_handling` | *boolean* | `null` | Indicates the package requires special handling. |
| `non_machinable` | *boolean* | `false` | Indicates that the package cannot be processed through sorting machines. |
| `saturday_delivery` | *boolean* | `false` | Indicates 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](/apis/shipengine/docs/reference/list-carrier-options).

## Manifests

Purolator automatically manifests all shipments at midnight ET each day. You do not need to manually [manifest](/apis/shipengine/docs/shipping/manifests) your Purolator shipments.

## Scheduling Pickups

Purolator from ShipStation supports [scheduling pickups](/apis/shipengine/docs/shipping/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](/apis/shipengine/docs/pick-up-drop-off/pudo-intro).

## Tracking

Purolator from ShipStation supports receiving tracking updates. Review our ​[Track a Package guides​](/apis/shipengine/docs/tracking/tracking)​ for details on tracking with the ShipStation API.