0% found this document useful (0 votes)
19 views

XpressBeesReverse Pickup Tracking API Service Implementation Documentation v3.2

This document outlines the implementation details for the XpressBees Reverse Manifest Status API, which allows users to retrieve bulk reverse shipment details via a POST request. The API requires an access key and can handle up to 10 AWB numbers in a single request, returning either successful shipment information or error messages based on the input. It also specifies the expected JSON output format and various status codes related to shipment processing.

Uploaded by

user6softpulse
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
19 views

XpressBeesReverse Pickup Tracking API Service Implementation Documentation v3.2

This document outlines the implementation details for the XpressBees Reverse Manifest Status API, which allows users to retrieve bulk reverse shipment details via a POST request. The API requires an access key and can handle up to 10 AWB numbers in a single request, returning either successful shipment information or error messages based on the input. It also specifies the expected JSON output format and various status codes related to shipment processing.

Uploaded by

user6softpulse
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

XpressBees Reverse Manifest Status API Service Implementation Documentation Summary

Summary
The purpose of this document is to describe our approach to Service allow you to get bulk reverse shipment
details to help us refine it to better serve you.
Reverse Manifest Status API Details:
 URL:
http://114.143.206.69:803/StandardReverseStagingService.svc/GetBulkReverseManifestStatus
 Request JSON : { "XBkey":"{XB Access Key}","AWBNumber":"1XRBC432751,21618514846"}
◦ XBKey: The “XB Access Key ID” of the owner of the service who will be granting Anonymous
access for a request that satisfies the set of constraints in the policy
 Method Type: POST
 Content-Type: application/json
 Allows max 10 AWBNo in one request and AWBNo must be in comma (,) separated
Json Output :
1. Succesful:
[
{
"AuthKey": "Vaild",
"ReturnMessage": "Successful",
"AWBNumber": "1271200062",
"OrderNo": "SDHKSZY7J9G",
"DestinationAddress": "30 Soukya Road, KacharkanahalliVillage",
"DestinationCity": "Bangalore",
"DestinationState": "Karnataka",
"DestinationPinCode": "110000",
"DestinationPhoneNo": "98656985958",
"StatusCode": "Undelivered",
"Status": "UD",
"ActionDate": "06-08-2018 18:12:10",
"Reason": "Warehouse Closed"
},
{
"AuthKey": "Vaild",
"ReturnMessage": "Successful",
"AWBNumber": "127124500251",
"OrderNo": "SDHKSZPSD797",
"DestinationAddress": "Flat no. 30, Bhavani nagar, Pune",
"DestinationCity": "Bangalore",
"DestinationState": "Karnataka",
"DestinationPinCode": "411016",
"DestinationPhoneNo": "98656985958",
"StatusCode": "RP",
"Status": "RPPickDone",
"ActionDate": "07-08-2018 15:10:50",

Xpressbees Reverse Manifest Status API V4.0 1


"Reason": null
},
{
"AuthKey": "Vaild",
"ReturnMessage": "Successful",
"AWBNumber": "227180802012",
"OrderNo": "SDHKSZPSD799",
"DestinationAddress": "Flat no. 30, Bhavani Nagar, Pune",
"DestinationCity": "Delhi",
"DestinationState": "New Delhi",
"DestinationPinCode": "110010",
"DestinationPhoneNo": "9865698595",
"StatusCode": "IT",
"Status": "IT",
"ActionDate": "02-08-2018 10:08:19",
"Reason": null
}
]
2. Error:
1. Invalid xbAccessKey:
[{
"AuthKey": "Invalid xbAccessKey",
"ReturnMessage": "Invalid xbAccessKey",
"AWBNumber": null,
"OrderNo": null,
"DestinationAddress": null,
"DestinationCity": null,
"DestinationState": null,
"DestinationPinCode": null,
"DestinationPhoneNo": null,
"StatusCode": null,
"Status": null,
"ActionDate": null,
"Reason": null
}]
2. AWB number is null/empty:
[{
"AuthKey": "Valid",
"ReturnMessage": "Please provide AWB number",
"AWBNumber": null,

Xpressbees Reverse Manifest Status API V4.0 2


"OrderNo": null,
"DestinationAddress": null,
"DestinationCity": null,
"DestinationState": null,
"DestinationPinCode": null,
"DestinationPhoneNo": null,
"StatusCode": null,
"Status": null,
"ActionDate": null,
"Reason": null
}]
3. If status (which is mentioend in below table) other than anything:
[{
"AuthKey": "Valid",
"ReturnMessage": "Shipment status not updated",
"AWBNumber": null,
"OrderNo": null,
"DestinationAddress": null,
"DestinationCity": null,
"DestinationState": null,
"DestinationPinCode": null,
"DestinationPhoneNo": null,
"StatusCode": null,
"Status": null,
"ActionDate": null,
"Reason": null
}]

4. If data not found:


[{
"AuthKey": "Valid",
"ReturnMessage": "Data not found",
"AWBNumber": null,
"OrderNo": null,

Xpressbees Reverse Manifest Status API V4.0 3


"DestinationAddress": null,
"DestinationCity": null,
"DestinationState": null,
"DestinationPinCode": null,
"DestinationPhoneNo": null,
"StatusCode": null,
"Status": null,
"ActionDate": null,
"Reason": null
}]
5. If any other error:
[{
"AuthKey": "Valid",
"ReturnMessage": "Operation failed",
"AWBNumber": null,
"OrderNo": null,
"DestinationAddress": null,
"DestinationCity": null,
"DestinationState": null,
"DestinationPinCode": null,
"DestinationPhoneNo": null,
"StatusCode": null,
"Status": null,
"ActionDate": null,
"Reason": null
}]

NOTE:
 Date format: “dd-MM-yyyy HH:mm:ss” eg “19-07-2018 15:23:10”
 Status Code:

Status Code Status Description


Pending RPPickupPending Shipment data received but not picked
RP RPPickDone Shipment picked
RPCancel RPCancel Reverse pick-up request cancelled
RPOutForPickUp RPOutForPickUp Shipment allocated for pickup

Xpressbees Reverse Manifest Status API V4.0 4


RPAttemptNotPick RPAttemptNotPick Shipment attempt but not picked
IT IT Shipment in transit
RAD RAD Shipment reached at destination
OFD OFD Shipment out for delivery
RD DLVD Shipment delivered/handover
UD UD Shipment undelivered

Xpressbees Reverse Manifest Status API V4.0 5

You might also like