Properties
| Name | Type | Description |
|---|---|---|
| pickupDetails | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/purolator/main/json-schema/purolator-history-api-response-schema.json",
"title": "HistoryApiResponse",
"x-generated": "2026-10-13",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/purolator-pickup-openapi.yml#/components/schemas/HistoryApiResponse",
"type": "object",
"properties": {
"pickupDetails": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/GetPickupCourierResponse"
},
{
"$ref": "#/$defs/GetPickupFreightResponse"
}
]
}
}
},
"required": [
"pickupDetails"
],
"$defs": {
"BoolValuePair": {
"type": "object",
"required": [
"keyword",
"keywordValue"
],
"properties": {
"keyword": {
"type": "string",
"enum": [
"2MEN",
"APPT",
"ID",
"MULT DRP",
"OFFDAY",
"RESID",
"TAILGATE",
"TSDEL",
"VALUE",
"DG",
"DGPL",
"HEAT",
"PREAPPT"
],
"description": "Optional accessorial parameter keywords."
},
"keywordValue": {
"type": "boolean",
"description": "Whether the keyword value in this object should be true or false."
}
}
},
"ContactInformation": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the contact.",
"minimum": 2,
"maxLength": 30
},
"company": {
"type": "string",
"description": "Company name.",
"maxLength": 30
},
"phoneNumber": {
"type": "string",
"description": "Expected format '14031234567', '4031234567' '416-569-5654', '(416)-569-5654'"
},
"phoneExtension": {
"type": "string",
"description": "Expected format, Only digit with length upto 10"
}
},
"required": [
"name",
"phoneNumber"
]
},
"Freight": {
"type": "object",
"properties": {
"paymentInfo": {
"$ref": "#/$defs/PaymentInformation"
},
"declaredValue": {
"type": "number",
"format": "double",
"multipleOf": 0.01,
"description": ""
},
"codAmount": {
"type": "number",
"format": "double",
"multipleOf": 0.01,
"description": "Cash on delivery amount."
},
"accessorialParameters": {
"type": "array",
"items": {
"$ref": "#/$defs/BoolValuePair"
}
},
"pickUpOptions": {
"type": "string",
"enum": [
"DG",
"Oversize",
"Rush",
"TempCtrl"
]
},
"lineItemDetails": {
"description": "Shipment particulars",
"type": "array",
"items": {
"$ref": "#/$defs/LineItem"
}
},
"customerReferences": {
"type": "array",
"enum": [
"PO",
"BOL"
],
"items": {
"type": "string"
}
}
},
"required": [
"paymentInfo"
]
},
"GetBaseResponse": {
"type": "object",
"properties": {
"pickupConfirmationNumber": {
"type": "string",
"description": "Shipment pickup confirmation number"
},
"pickupStatus": {
"type": "string",
"description": "Filter by particular status. Case-insensitive.",
"enum": [
"Scheduled",
"Dispatched",
"Cancelled",
"NoPickup",
"PickedUp",
"Pending"
]
}
}
},
"GetPickupCourierResponse": {
"allOf": [
{
"$ref": "#/$defs/PickupCourier"
},
{
"$ref": "#/$defs/GetBaseResponse"
}
]
},
"GetPickupFreightResponse": {
"allOf": [
{
"$ref": "#/$defs/PickupFreight"
},
{
"$ref": "#/$defs/GetBaseResponse"
}
]
},
"LineItem": {
"type": "object",
"required": [
"lineNumber",
"pieces",
"handlingUnit",
"handlingUnitType",
"weight",
"length",
"width",
"height"
],
"properties": {
"lineNumber": {
"type": "integer",
"description": "Line item number of the corresponding shipment description."
},
"pieces": {
"type": "integer",
"description": "Number of pieces on the handling unit"
},
"handlingUnit": {
"type": "integer",
"description": "Number of handling units"
},
"handlingUnitType": {
"type": "string",
"enum": [
"PALLET",
"BOX",
"SKID",
"REEL",
"ROLL",
"BIN",
"BUNDLE",
"CAGE",
"UNIT",
"DRUM"
],
"description": "Type of handling unit"
},
"description": {
"type": "string",
"maximum": 250,
"description": "Description of handling unit type"
},
"freightClass": {
"type": "string",
"description": ""
},
"weight": {
"type": "number",
"format": "double",
"multipleOf": 0.01,
"maximum": 1000000000000,
"minimum": 0,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"description": "Weight of the line item in your selected unit of measure (kg or lbs). Weight must be greater than 0."
},
"length": {
"type": "number",
"format": "double",
"multipleOf": 0.01,
"maximum": 1000,
"minimum": 0,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"description": "Length of the line item in your selected unit of measure (in or cm). Length must be greater than 0."
},
"width": {
"type": "number",
"format": "double",
"multipleOf": 0.01,
"maximum": 1000,
"minimum": 0,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"description": "Width of the line item in your selected unit of measure (in or cm). Width must be greater than 0."
},
"height": {
"type": "number",
"format": "double",
"multipleOf": 0.01,
"maximum": 1000,
"minimum": 0,
"exclusiveMaximum": true,
"exclusiveMinimum": true,
"description": "Height of the line item in your selected unit of measure (in or cm). Height must be greater than 0."
}
}
},
"PaymentInformation": {
"type": "object",
"properties": {
"paymentType": {
"type": "string",
"description": "Specifies where shipping charges should be billed to",
"enum": [
"Sender",
"Receiver",
"ThirdParty"
]
},
"billingAccountNumber": {
"type": "string",
"description": "Registered freight account number tied to the production key. It is a required when paymentType is ThirdParty, and optional for Sender or Receiver."
}
},
"required": [
"paymentType"
]
},
"PickupAddress": {
"type": "object",
"properties": {
"address": {
"type": "array",
"description": "A maximum of 3 strings are allowed, with at least one line required, and each line can contain up to 35 characters.",
"items": {
"type": "string"
}
},
"province": {
"type": "string",
"description": "Province cod. Case-insensitive.",
"enum": [
"AB",
"BC",
"MB",
"NB",
"NL",
"NS",
"NT",
"NU",
true,
"PE",
"QC",
"SK",
"YT"
]
},
"city": {
"type": "string",
"description": "Name of the city",
"maxLength": 40
},
"country": {
"type": "string",
"description": "Country code. Case-insensitive.",
"enum": [
"CA"
]
},
"postalCode": {
"type": "string",
"description": "Expected format L5R3T8 or L5R 3T8 and should be a valid postal code"
}
},
"required": [
"address",
"city",
"country",
"postalCode",
"province"
]
},
"PickupCourier": {
"type": "object",
"properties": {
"registeredAccountNumber": {
"type": "string",
"description": "Purolator Business Account Number",
"maxLength": 10,
"minLength": 1
},
"pickupInstructions": {
"$ref": "#/$defs/PickupInstructions"
},
"pickupAddress": {
"$ref": "#/$defs/PickupAddress"
},
"shipmentSummary": {
"type": "array",
"description": "Shipment Summary Details cannot contain multiple entries with the same Destination Code.",
"items": {
"$ref": "#/$defs/ShipmentSummaryDetails"
}
},
"contactInfo": {
"$ref": "#/$defs/ContactInformation"
},
"pickupNotificationEmail": {
"type": "string",
"description": "Email address must not exceed 70 char."
},
"lineOfBusiness": {
"type": "string",
"description": "Line of business which the pickup is for. Case-insensitive.",
"enum": [
"Courier",
"Freight"
]
}
},
"required": [
"registeredAccountNumber",
"lineOfBusiness",
"contactInfo",
"pickupAddress",
"pickupInstructions",
"shipmentSummary"
]
},
"PickupFreight": {
"allOf": [
{
"$ref": "#/$defs/PickupCourier"
},
{
"type": "object",
"properties": {
"freight": {
"$ref": "#/$defs/Freight"
}
}
}
]
},
"PickupInstructions": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "Requested pickup date. Required date format \"YYYY-MM-DD\"."
},
"anyTimeAfter": {
"type": "string",
"description": "Earliest pickup time. Time format in 24-hour notation(\"HH:mm\")."
},
"untilTime": {
"type": "string",
"description": "Latest pickup time. Time format in 24-hour notation(\"HH:mm\")."
},
"measurementUnit": {
"type": "string",
"description": "The unit of measurement used for package weight and lengths. Imperial uses pounds and inches, while metric uses kilograms and centimeters. Case-insensitive.",
"enum": [
"Imperial",
"Metric"
]
},
"totalWeight": {
"type": "number"
},
"pickupLocation": {
"type": "string",
"description": "Location for where to pickup the shipment. Case-insensitive.",
"enum": [
"BackDoor",
"Basement",
"BetweenDoors",
"Counter",
"Desk",
"FrontDesk",
"FrontDoor",
"FrontPorch",
"Garage",
"GateHouse",
"Kiosk",
"Lab",
"LoadingDock",
"Lobby",
"Mailbox",
"MailRoom",
"Office",
"OutsideDoor",
"PartsDepartment",
"Pharmacy",
"ProShop",
"Receiving",
"Reception",
"Security",
"ServiceCounter",
"Shipping",
"SideDoor",
"Switchboard",
"Vault",
"Warehouse"
]
},
"additionalInstructions": {
"type": "string",
"description": "Additional pickup instructions.",
"maxLength": 70
},
"supplyRequestCodes": {
"type": "array",
"description": "Request supplies with pickup. Case-insensitive.",
"enum": [
"1030AMStickers",
"9AMStickers",
"AirStickers",
"ExpressEnvelope",
"ExpressPack",
"HeavyWeightSticker",
"HoldforPUSticker",
"InternationalBillOfLading",
"Labelope",
"Manifest",
"RegularBillOfLading",
"SaturdayServiceSticker"
],
"items": {
"type": "string"
}
},
"trailerAccessible": {
"type": "boolean",
"description": "Whether or not your location can accommodate a 53' trailer."
},
"loadingDockAvailable": {
"type": "boolean",
"description": "Whether or not a loading dock is available at your location."
},
"shipmentOnSkids": {
"type": "boolean",
"description": "Whether or not your shipment is on skids."
},
"numberOfSkids": {
"type": "integer",
"description": "Number of skids",
"minimum": 0,
"maximum": 9999
}
},
"required": [
"anyTimeAfter",
"date",
"pickupLocation",
"untilTime",
"measurementUnit"
]
},
"ShipmentSummaryDetails": {
"type": "object",
"properties": {
"destinationCode": {
"type": "string",
"description": "Shipment destination code. Case-insensitive.",
"enum": [
"DOM",
"INTL",
"USA"
]
},
"totalPieces": {
"type": "integer",
"description": "Number of pieces for a shipment destination",
"minimum": 1,
"maximum": 9999
},
"totalWeight": {
"type": "number",
"description": "Weight for per piece cannot exceed 150LB or 68KG"
},
"modeOfTransport": {
"type": "string",
"description": "Mode of transport. Case-insensitive.",
"enum": [
"Air",
"Ground",
"Air/Ground"
]
}
},
"required": [
"destinationCode",
"totalPieces",
"totalWeight",
"modeOfTransport"
]
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/purolator-history-api-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.