Request

Parameter	Length	Possible Values	Description
partnerKey	32 Char	String. Given by Westcon Account manager	Reseller identifier.
orderNumber	9 Char	String	The Westcon order number for which the tracking is needed.
carrier	25 Char	Carrier value from Shipment Detail response
trackingNumber	30 Char	String	A single tracking number to search.

Note

Some carriers have limitations on how often tracking queries can be initiated, see below for details.

Carrier	Limitation
StarTrack	10 per minute
CourierPost	15 per second

Response Limitations

Some carriers are unable to provide certain data as part of their tracking data, below is a list of parameters by carrier which are not provided.

Carrier	Parameter
CourierPost	shipmentDate pieces weight weightUnit estimatedDeliveryDate serviceEvents/eventLocation
StarTrack	shipmentDate weight weightUnit
TNT	shipmentDate weight weightUnit estimatedDeliveryDate

Response

Parameter	Length	Data type	Description
orderNumber	Char9	String	The Westcon order number for which the status is needed.
carrier	Char25	String	Carrier code associated with the tracking number.
trackingNumber	Char30	String	A single tracking number to search on.
shipmentDate	Char19	yyyy-mm-ddThh:mm:ss	This timestamp identifies the ready date and time of the shipment.
pieces	Char3	String	Number of the Piece.
weight	Char15	String	Weight of shipment.
weightUnit	Char1	L = Pounds K = Kilogram G = Grams	Weight unit of measure.
estimatedDeliveryDate	Char19	yyyy-mm-ddThh:mm:ss	This timestamp identifies the estimated delivery date and time of the shipment.
deliveryDate	Char19	yyyy-mm-ddThh:mm:ss	This timestamp identifies the actual delivery date and time of the shipment.
signature	Char50	String	The signee for the piece.
signatureImage	--	Base64 encoded string or URL	Signature Image it may take a few days for the image to be available from the carrier
signatureImageType	Char10	The image type in the signatureImage field used to decode the string.	Signature Image Type
additionalImages	--	additionalImages	List of images available for this shipment
serviceEvents	--	serviceEvents	Detailing the specific shipment events.
errorCode	Char4	String	See Error Codes.
errorDescription	--	String	Error Description.

additionalImages

Parameter	Length	Data type	Description
image	--	Base64 encoded string
imageDate	Char19	yyyy-mm-ddThh:mm:ss	This timestamp identifies the actual date and time of the image.
imageType	Char10	The image type in the image field used to decode the string.	Image Type

serviceEvents

Parameter	Length	Data type	Description
eventDate	Char10	yyyy-mm-dd	Local date of shipment event.
eventTime	Char8	hh:mm:ss	Local time of shipment event.
eventLocation	--	String	Location of shipment event.
eventDescription	--	String	Description of shipment event.

Signature Image Types

Image Format	Description
PDF	Base64 encoded string of a PDF document
PNG	Base64 encoded string of an image file