Parcel Delivery: Shipping Manager - Shipping API

Already have an account? Sign in below
		Login Now

Track & Trace

HOME ABOUT NEWS QUOTE & BOOK EBAY LOGIN SIGNUP FAQS SUPPORT CONTACT

The Shipping API: ParcelStatus

This function allows you to get the current status of a parcel you have booked.

Input Fields

Field Name	Required?	Description	Example
ShipAction	YES	This tells our system which function you require	ParcelStatus
Username	YES	You must specify your username	joebloggs
APIKey	YES	This is available from your Shipping Manager account page	HJ1E6DOTRDXAOL4LWBB
OrderNumber	YES	This must be a valid PSM order number	PSM12345

Output Fields

Field Name Description Example

ShipAction Confirmation of the function used ParcelStatus

Status Either Success or Error Success

RequestDate The date your request was received (yyyy-mm-dd hh:mm:ss) 2008-01-10 12:15:31

Username The username used to make the request joebloggs

OrderNumber The order number you are enquiring about PSM12345

Collected Whether the parcel has been collected (1 = yes, 0 = no) 1

Delivered Whether the parcel has been successfully delivered (1 = yes, 0 = no) 1

Returned Whether the parcel has been returned to sender (1 = yes, 0 = no) 0

Example Input

Array
(
    [ShipAction] => ParcelStatus
    [Username] => joebloggs
    [APIKey] => HJ1E6DOTRDXAOL4LWBB
    [OrderNumber] => PSM12345
)

Example Output

Array
(
    [ShipAction] => ParcelStatus
    [Status] => Success
    [RequestDate] => 2008-01-10 12:15:31
    [Username] => joebloggs
    [OrderNumber] => PSM12345
    [Collected] => 1
    [Delivered] => 1
    [Returned] => 0
)

<< Go back to API home page