View Purolator Services

Purolator Pickup Virtual Sandbox

API for scheduling, modifying, and managing courier pickup requests.

The Purolator Pickup API allows developers to programmatically manage shipment pickups. It supports scheduling new pickups, modifying existing requests, retrieving pickup history, and voiding scheduled pickups, providing a complete lifecycle management tool for logistics integration.

Use this hosted sandbox to simulate Purolator Pickup APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Use cases:

Use this sandbox to validate pickup scheduling payloads, address validation logic, time-window availability, modification request workflows, and error handling for voiding or retrieving historical pickup data before integrating with Purolator production systems.

Purolator Pickup virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate Purolator Pickup responses instantly.

https://purolator-pickup.mock.beeceptor.com



pickup(4 operations)

Header NameExample
x-api-key*"aute dolore"
Language*"FR"
RequestReference"magna sint proident"
Request Payload
{
  "contactInfo": {
    "company": "Gorczany - Robel",
    "name": "Sheri Strosin",
    "phoneExtension": "5",
    "phoneNumber": "+19233368285"
  },
  "lineOfBusiness": "Courier",
  "pickupAddress": {
    "address": {
      "0": "123 Main St"
    },
    "city": "Schusterberg",
    "country": "CA",
    "postalCode": "X7J 8A7",
    "province": "ON"
  },
  "pickupInstructions": {
    "additionalInstructions": "Leave at front desk",
    "anyTimeAfter": "11:00",
    "date": "2026-10-10T00:00:00.0Z",
    "loadingDockAvailable": true,
    "measurementUnit": "Imperial",
    "numberOfSkids": 8,
    "pickupLocation": "FrontDesk",
    "shipmentOnSkids": false,
    "supplyRequestCodes": {
      "0": "ExpressEnvelope"
    },
    "totalWeight": 279.3,
    "trailerAccessible": false,
    "untilTime": "17:00"
  },
  "pickupNotificationEmail": "Morton.Boyer75@yahoo.com",
  "registeredAccountNumber": "3",
  "shipmentSummary": [
    {
      "destinationCode": "INTL",
      "modeOfTransport": "Ground",
      "totalPieces": 37,
      "totalWeight": 26.8
    },
    {
      "destinationCode": "USA",
      "modeOfTransport": "Ground",
      "totalPieces": 84,
      "totalWeight": 7.4
    },
    {
      "destinationCode": "INTL",
      "modeOfTransport": "Ground",
      "totalPieces": 94,
      "totalWeight": 92.4
    },
    {
      "destinationCode": "DOM",
      "modeOfTransport": "Ground",
      "totalPieces": 94,
      "totalWeight": 43.6
    },
    {
      "destinationCode": "DOM",
      "modeOfTransport": "Ground",
      "totalPieces": 40,
      "totalWeight": 45.1
    }
  ]
}
Response Payload
{
  "pickupConfirmationNumber": "9"
}
{
  "errors": [
    {
      "code": "9001-21",
      "description": "Invalid account number."
    },
    {
      "code": "9001-19",
      "description": "Invalid account number."
    },
    {
      "code": "9001-21",
      "description": "Invalid account number."
    },
    {
      "code": "9001-21",
      "description": "Shipment summary is required."
    }
  ]
}
{
  "message": "User is not authorized to access this resource."
}
{
  "code": "9001-73",
  "description": "There is an unknown internal server error. Please try again later."
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Header NameExample
x-api-key*"dolore esse Excepteur mollit magna"
Language*"EN"
RequestReference"exercitation Lorem ipsum dolor"
Request Payload
{
  "pickupConfirmationNumber": "6",
  "pickupInstructions": {
    "additionalInstructions": "Call after 5pm",
    "measurementUnit": "imperial",
    "pickupLocation": "FrontDesk",
    "supplyRequestCodes": [
      "ExpressEnvelope"
    ],
    "untilTime": "16:00"
  },
  "registeredAccountNumber": "7",
  "shipmentSummary": [
    {
      "destinationCode": "USA",
      "totalPieces": 44,
      "totalWeight": 23.6
    },
    {
      "destinationCode": "DOM",
      "totalPieces": 37,
      "totalWeight": 83.1
    },
    {
      "destinationCode": "USA",
      "totalPieces": 2,
      "totalWeight": 83
    },
    {
      "destinationCode": "DOM",
      "totalPieces": 29,
      "totalWeight": 41
    }
  ]
}
Response Payload
{
  "pickupConfirmationNumber": "4"
}
{
  "errors": [
    {
      "code": "9001-21",
      "description": "Service currently unavailable."
    },
    {
      "code": "9001-20",
      "description": "Invalid account number."
    },
    {
      "code": "9001-21",
      "description": "Service currently unavailable."
    }
  ]
}
{
  "message": "User is not authorized to access this resource."
}
{
  "code": "9001-73",
  "description": "There is an unknown internal server error. Please try again later."
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Header NameExample
x-api-key*"et Excepteur do cupidatat"
Language*"FR"
RequestReference"enim do"
Request Payload
{
  "fromDate": "2026-05-13T00:00:00.0Z",
  "lineOfBusiness": "Courier",
  "pickupConfirmationNumber": [
    "2214236",
    "3326587"
  ],
  "registeredAccountNumber": "7",
  "status": "PickedUp",
  "toDate": "2026-07-26T00:00:00.0Z"
}
Response Payload
{
  "pickupDetails": [
    {
      "contactInfo": {
        "company": "Lowe and Sons",
        "name": "Dr. Rafael Davis",
        "phoneExtension": "3",
        "phoneNumber": "+13184099126"
      },
      "freight": {
        "accessorialParameters": [
          {
            "keyword": "ID",
            "keywordValue": true
          },
          {
            "keyword": "ID",
            "keywordValue": false
          },
          {
            "keyword": "ID",
            "keywordValue": false
          },
          {
            "keyword": "ID",
            "keywordValue": true
          },
          {
            "keyword": "ID",
            "keywordValue": false
          }
        ],
        "codAmount": 131.69,
        "customerReferences": {
          "0": "PO",
          "1": "BOL"
        },
        "declaredValue": 480.87,
        "lineItemDetails": [
          {
            "description": "Books",
            "freightClass": "70",
            "handlingUnit": 8,
            "handlingUnitType": "BOX",
            "height": 28.85,
            "length": 26.2,
            "lineNumber": 9,
            "pieces": 16,
            "weight": 74.23,
            "width": 17.03
          }
        ],
        "paymentInfo": {
          "billingAccountNumber": "6",
          "paymentType": "Sender"
        },
        "pickUpOptions": "Oversize"
      },
      "lineOfBusiness": "Courier",
      "pickupAddress": {
        "address": {
          "0": "123 Main St"
        },
        "city": "East Davon",
        "country": "CA",
        "postalCode": "P1K 4W5",
        "province": "ON"
      },
      "pickupConfirmationNumber": "7",
      "pickupInstructions": {
        "additionalInstructions": "Leave at front desk",
        "anyTimeAfter": "12:00",
        "date": "2027-01-18T00:00:00.0Z",
        "loadingDockAvailable": false,
        "measurementUnit": "Imperial",
        "numberOfSkids": 6,
        "pickupLocation": "FrontDesk",
        "shipmentOnSkids": false,
        "supplyRequestCodes": {
          "0": "ExpressEnvelope"
        },
        "totalWeight": 307.4,
        "trailerAccessible": false,
        "untilTime": "17:00"
      },
      "pickupNotificationEmail": "Melissa.Johnston30@gmail.com",
      "pickupStatus": "PickedUp",
      "registeredAccountNumber": "4",
      "shipmentSummary": [
        {
          "destinationCode": "INTL",
          "modeOfTransport": "Ground",
          "totalPieces": 39,
          "totalWeight": 46.5
        },
        {
          "destinationCode": "INTL",
          "modeOfTransport": "Ground",
          "totalPieces": 32,
          "totalWeight": 100
        }
      ]
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "code": "9001-19",
      "description": "Invalid account number."
    },
    {
      "code": "9001-20",
      "description": "Service currently unavailable."
    },
    {
      "code": "9001-20",
      "description": "Shipment summary is required."
    }
  ]
}
{
  "message": "User is not authorized to access this resource."
}
{
  "code": "9001-73",
  "description": "There is an unknown internal server error. Please try again later."
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Header NameExample
x-api-key*"laboris Excepteur ut minim nostrud"
Language*"FR"
RequestReference"in"
Request Payload
{
  "lineOfBusiness": "Courier",
  "pickupConfirmationNumber": "9"
}
Response Payload
{
  "pickupVoided": true
}
{
  "errors": [
    {
      "code": "9001-20",
      "description": "Invalid account number."
    }
  ]
}
{
  "message": "User is not authorized to access this resource."
}
{
  "code": "9001-73",
  "description": "There is an unknown internal server error. Please try again later."
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Service Homepage: developer.purolator.com/
purolatorlogisticsshippingpickupcourier