Purolator


Overview

Purolator is a Canadian carrier which offers domestic and international shipping, tracking, and solutions services (Business and Technology). We, PB SendTech Solutions, deal with Shipping services only.

Onboarding of a Purolator Carrier Account

To onboard a Purolator carrier account, the user needs to possess the following pre-requisites:

  • An Account Number
  • Security Credentials in the form of User ID.

Further, an API request is executed, which encompasses all the necessary information. Below is the sample request to onboard the carrier:

Purolator Sample Request
Copy
Copied
{

    "accountNumber": "9999999999",
    "carrierID": "PUROLATOR",
    "description": "PUROLATOR by API",
    "carrierAccountType": "Shipping",
    "provisioningType": "API",
    "parameters": {
        "userID": "d4b60186-c573-4303-82f2-a5655a129c4b"
    }
}

If the request to establish the Purolator carrier account is successful, the resulting response will resemble the Sample Response provided below.

Purolator Sample Response
Copy
Copied
{
    "carrierAccountID": "vLpAg9xxxxx",
    "description": "PUROLATOR by API",
    "carrierID": "PUROLATOR",
    "accountNumber": "9999999999",
    "parameters": {
        "userID": "d4b60186-c573-4303-82f2-a5655a129c4b"
    },
    "carrierAccountType": "Shipping",
    "provisioningType": "API"
}

API Operations for Shipping with Purolator

The APIs integrate with Purolator through the following operations:

OperationsMethodResource Path
Add a Carrier AccountPOST/api/v1/carrierAccounts
Rate a ParcelPOST/api/v1/rates
Create a Shipping LabelPOST/api/v1/shipments
Reprint a LabelGET/api/v1/shipments/{{shipmentId}}/reprint
Void a LabelPUT/api/v1/shipments/{{shipmentId}}/cancel
Get Tracking InformationGET/api/v1/tracking/{{trackingNumber}}

Purolator also supports shipmentByRateShop operations:
OperationsMethodResource Path
Create a Shipping LabelPOST/api/v2/shipments
Reprint a LabelPOST/api/v2/shipments/reprint
Void a LabelPOST/api/v2/shipments/cancel

Metadata

Metadata provides information about Purolator carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.

Metadata information not available