# 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](/content/docs/new-shipstation-api/index.html).

# Purolator Canada

[Purolator Canada](https://www.purolator.com/en/home.page) offers domestic and international shipping services to accounts shipping from Canada.

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

If you are using or plan to use the Purolator services included with ShipStation API, rather than connecting your own Purolator Canada account, see our [Purolator from ShipStation guide](/content/docs/carriers/purolator-from-shipengine/index.html).

## Requirements

| Property            | Type     | Required? | Description                                              |
|---------------------|----------|-----------|----------------------------------------------------------|
| `nickname`          | _string_ | **required** | Used to identify your account in ShipStation API        |
| `account_number`    | _string_ | **required** | Your Purolator account number                              |
| `activation_key`    | _string_ | **required** | Your Purolator account activation key                      |

### Shipping Requirements

- Maximum shipment weight is 150 lbs. Shipments greater than 70 lbs will automatically be considered to require Special Handling and receive an $18.00 surcharge.

## Connect Account

You can connect a Purolator Canada account using the POST method to the `/v1/connections/carriers/` endpoint, or via the [ShipStation API Dashboard](https://help.shipengine.com/hc/en-us/articles/4406863365531-Purolator).

### Connect Your Purolator Account to ShipEngine

To connect your Purolator account to ShipEngine, you'll first need to obtain your activation key from Purolator. You can then complete the connection process in ShipEngine.

#### 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.
4. Click **Activation Keys** on the API Portal dashboard. Then click **Request Activation Key**.
5. Select **ShipStation / ShipEngine** as the appropriate company from the _Who is your eCommerce solution provider?_ drop-down menu. Then click **Next**.
6. Complete the Purolator Business Account information as requested, then click **Next**.

> **IMPORTANT:** Account Number requires a minimum of 7 digits
> For example, for Account 123, you would need to add four additional 0s so it reads 0000123.

7. Complete the fields for _Where will your Purolator shipments be originating from?_, then accept the Terms and Agreements and click **Next**.
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.
9. Check your email. You should have a Purolator confirmation email from _[notificationservice@purolator.com](mailto: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](https://dashboard.shipengine.com/).

### Connect via Endpoint

`carrier_name`: `purolator_ca`

**POST /v1/connections/carriers/:carrier_name**

Sample request:

```
POST /v1/connections/carriers/purolator_ca HTTP/1.1
{
  "nickname": "My Purolator Canada account",
  "account_number": "123456789",
  "activation_key": "123456789"
}
```

A successful connection will return a response with the `carrier_id` that you'll use for any requests for this account going forward.

### Rates

Purolator Canada supports [rate shopping](/content/docs/rates/index.html) with ShipStation API.

### Service Details

The available services for Purolator Canada appear below:

### 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`   |
| Purolator Ground Distribution      | `purolator_ground_distribution`|

### International Services

| Service                          | API Code                     |
|----------------------------------|------------------------------|
| Purolator Express U.S.           | `purolator_express_us`       |
| Purolator Express U.S. 9AM       | `purolator_express_us9am`    |
| Purolator Express U.S. 10:30AM   | `purolator_express_us1030am` |
| Purolator Express U.S. 12:00     | `purolator_express_us1200`   |
| Purolator Ground U.S.            | `purolator_groundus`         |
| Purolator Express International    | `purolator_express_international` |
| Purolator Express International 9AM | `purolator_express_international_9am` |
| Purolator Express International 10:30 AM | `purolator_express_international_1030am` |
| Purolator Express International 12:00 | `purolator_express_international_1200` |

### 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.
| Adult signature required           | `adult_signature`             | An adult signature is required for the shipment to be delivered.
| Residential signature Intl          | `direct_signature`            | A signature of somebody at the address is required.

### Advanced Options

| Option                   | Type     | Default Value | Description                                                            |
|--------------------------|----------|---------------|------------------------------------------------------------------------|
| `additional_handling`   | _boolean_ | `null`        | Indicates the package requires special handling.                       |
| `bill_to_party`         | _string_  | `null`        | Determines which party is paying for shipping costs.                  |
| `dangerous_goods`       | _boolean_ | `false`       | Indicates if dangerous goods are present in the shipment.             |
| `delivered_duty_paid`   | _boolean_ | `false`       | Indicates the shipment is DDP (that is, the shipper is paying the duties/taxes). |
|
### Manifests

Purolator Canada manifests your shipments automatically at the end of the day, so there is no need to manually [manifests page](/content/docs/shipping/manifests/index.html) shipments with ShipStation API.

### Tracking

ShipStation API's integration with Purolator Canada supports receiving tracking updates. Review our ​ [Track a Package guides​](/content/docs/tracking/index.html) ​ for details on tracking with the ShipStation API.