Purolator International Web Services Documentation - Confidential
Purolator International Web Services Documentation - Confidential
Web Services Overview
API Reference
Purolator.Webservice.Objects
AddItemRequestV3 Class
AddItemResponse Class
AddLTLPalletRequest Class
AddLTLPalletResponse Class
AddPackageRequestV3 Class
AddPackageResponse Class
Address Class
CloseoutDocument Class
CloseoutPackage Class
CloseoutRequest Class
CloseoutRequestLTLV3 Class
CloseoutRequestV3 Class
CloseoutResponse Class
CloseoutResponseLTLV3 Class
CloseoutResponseV3 Class
CloseoutWithWeightRequest Class
ContainerInfo Class
ContainerLabelsResponse Class
ContainerRequest Class
ContainerResponse Class
ContainersRequest Class
ContainersResponse Class
CredentialInfo Class
CustomsItemResponse Class
DocumentRequest Class
DocumentResponse Class
GetContainerLabelsRequest Class
GetContainerRequest Class
IDResponse Class
KeyValueDecimal Class
KeyValueStrings Class
LabelRequest Class
LabelRequestV3 Class
LabelResponse Class
LabelResponseV3 Class
LTLLabelRequest Class
LTLLabelResponse Class
LTLOrderRequest Class
LTLOrderRequestV3 Class
LTLOrderResponse Class
LTLOrderResponseV3 Class
LTLPalletListRequest Class
LTLPalletRequest Class
LTLPalletRequestV3 Class
LTLPalletResponse Class
LTLPalletResponseV3 Class
LTLShipmentListRequest Class
LTLShipmentRequest Class
LTLShipmentRequestV3 Class
LTLShipmentResponse Class
LTLShipmentResponseV3 Class
OrderListRequest Class
OrderListResponse Class
OrderPinListRequest Class
OrderPinListResponse Class
OrderRequestV3 Class
OrderResponseV3 Class
PackageContainerRequest Class
PackageContainerResponse Class
PackageIDWeight Class
PackageListRequest Class
PackageListResponse Class
PackageResponse Class
ParentChildContainerRequest Class
Rate Class
RateV3 Class
RequestItemEx Class
RequestItemV3 Class
RequestPackageV3 Class
ResponseBase Class
ResponseMessage Class
ResponseMessage.SeverityEnum Enumeration
ResponsePackage Class
ShipmentItemResponse Class
ShipperAccountServiceTypeLinkResponse Class
TemporaryLoginResponse Class
UpdateOrderInfo Class
UpdateOrderRequest Class
UpdateOrderResponse Class
VoidLTLShipmentListResponse Class
VoidPalletResponse Class
WebServiceConsoleNotificationHelper Class
ZPLInitializationResponse Class
Purolator.Webservice.Objects Namespace
[This is preliminary documentation and is subject to change.]
Defines objects supporting Purolator Webservice calls.
Classes
Class
Description
AddItemRequestV3
Request for
AddItem(AddItemRequestV3)
AddItemResponse
Response for
AddItem(AddItemRequestV3)
AddLTLPalletRequest
Request for
AddLTLPallets(AddLTLPalletRequest)
AddLTLPalletResponse
Response for
AddLTLPallets(AddLTLPalletRequest)
AddPackageRequestV3
Request for
AddPackage(AddPackageRequestV3)
AddPackageResponse
Response for
AddPackage(AddPackageRequestV3)
Address
Canadian Address
CloseoutDocument
ClosoeutDocuments are obsolete, and this field is never populated.
CloseoutPackage
Package information returned by
Closeout(CloseoutRequest)
CloseoutRequest
Request for
Closeout(CloseoutRequest)
CloseoutRequestLTLV3
Request for
CloseoutWithLTLV3(CloseoutRequestLTLV3)
CloseoutRequestV3
Request for
CloseoutV3(CloseoutRequestV3)
CloseoutResponse
Response for
Closeout
CloseoutResponseLTLV3
Response for
CloseoutWithLTLV3(CloseoutRequestLTLV3)
CloseoutResponseV3
Response for
CloseoutV3(CloseoutRequestLTLV3)
CloseoutWithWeightRequest
Request for
CloseoutUpdateWeight(CloseoutWithWeightRequest)
ContainerInfo
Request for
AddPackageContainer(AddPackageContainerRequest)
ContainerLabelsResponse
ContainerRequest
Request for
AddPackageContainer(AddPackageContainerRequest)
ContainerResponse
Response for
AddPackageContainer(AddPackageContainerRequest)
ContainersRequest
Request for
AddPackageContainer(AddPackageContainerRequest)
ContainersResponse
Response for
AddPackageContainer(AddPackageContainerRequest)
CredentialInfo
Login credentials for validation.
CustomsItemResponse
DocumentRequest
DocumentResponse
A document returned by
GetDocument(DocumentRequest)
GetContainerLabelsRequest
Request for
GetContainerLabels(GetContainerLabelsRequest)
GetContainerRequest
Request for
GetPackageContainer(GetPackageContainerRequest)
IDResponse
KeyValueDecimal
A serializable key/value string and decimal.
KeyValueStrings
A serializable key/value pair of strings.
LabelRequest
Request for
GetLabel(LabelRequest)
.
LabelRequestV3
Request for
GetLabelV3(LabelRequestV3)
.
LabelResponse
Response for
GetLabel(LabelRequest)
.
LabelResponseV3
Returned Package Label Data.
LTLLabelRequest
Request for
GetLTLLabel(LTLLabelRequest)
.
LTLLabelResponse
Response for
GetLTLLabel(LTLLabelRequest)
.
LTLOrderRequest
Request for
AddLTLOrder(LTLOrderRequest)
Adds an LTL order that will be included in a single LTL Shipment.
LTLOrderRequestV3
Request for
AddLTLOrderV3(LTLOrderRequestV3)
Adds an LTL order and LTL shipment.
LTLOrderResponse
LTLOrderResponseV3
LTLPalletListRequest
LTLPalletRequest
A Pallet included in an
LTLShipmentRequest
LTLPalletRequestV3
A Pallet included in an
LTLPalletRequestV3
LTLPalletResponse
A Pallet included in an
LTLShipmentResponse
LTLPalletResponseV3
A Pallet included in an
LTLShipmentResponse
LTLShipmentListRequest
The request for
VoidLTLShipments(LTLShipmentListRequest)
LTLShipmentRequest
Request for
AddConsolidatedLTLShipment(LTLShipmentRequest)
LTLShipmentRequestV3
Request for
AddConsolidatedLTLShipmentV3(LTLShipmentRequestV3)
LTLShipmentResponse
LTLShipmentResponseV3
Response for
AddConsolidatedLTLShipmentV3(LTLShipmentRequestV3)
OrderListRequest
The request for
VoidOrders(OrderListRequest)
OrderListResponse
The response returned by a CloseoutRequest.
OrderPinListRequest
The request for
VoidOrdersByPin(OrderPinListRequest)
OrderPinListResponse
OrderRequestV3
Request for
GetRates(OrderRequestV3)
and
AddOrder(OrderRequestV3)
OrderResponseV3
Response for
GetRates(OrderRequestV3)
and
AddOrder(OrderRequestV3)
PackageContainerRequest
Request for
AddPackageContainer(AddPackageContainerRequest)
PackageContainerResponse
Obsolete.
Response for
AddPackageContainer(AddPackageContainerRequest)
PackageIDWeight
Request for
CloseoutWithWeightRequest
PackageListRequest
The request for
ShipmentVerification(PackageListRequest)
and
VoidPackages(PackageListRequest)
PackageListResponse
The response returned by a CloseoutRequest.
PackageResponse
ParentChildContainerRequest
Request for
AddPackageContainer(AddPackageContainerRequest)
Rate
A single Rate returned in
OrderResponse
RateV3
A single Rate returned in
OrderResponseV3
RequestItemEx
An item contained in an order for customs purposes.
RequestItemV3
An item contained in an order for customs purposes. Item Data is required when Purolator is supporting customs clearance.
RequestPackageV3
Describes a package
ResponseBase
Base class for responses
ResponseMessage
The status and messages returned by each web service call.
ResponsePackage
Returned Package Data.
ShipmentItemResponse
ShipperAccountServiceTypeLinkResponse
A link indicating whether a shipping type is available to a Shipper Account
TemporaryLoginResponse
Returns a temporary login with an expiration date
UpdateOrderInfo
Order for
UpdateOrderRequest
UpdateOrderRequest
Request for
UpdateOrder(UpdateOrderRequest)
UpdateOrderResponse
Response for
UpdateOrder(UpdateOrderRequest)
VoidLTLShipmentListResponse
Response for
VoidLTLShipments(LTLShipmentListRequest)
.
VoidPalletResponse
WebServiceConsoleNotificationHelper
Helper class to send notifications to Console.
ZPLInitializationResponse
Response for
GetZPLInitializationImages(CredentialInfo)
Enumerations
Enumeration
Description
ResponseMessage
SeverityEnum
The severity of each message and the response status.
Send comments on this topic to
WorldPak