API

Manual
version 0.6
 API Features
Access Current status of mul9ple airwaybill
number
Access scans of Single airwaybill number
 API Access
Following are will be required for accessing the
details
URL: hGp://api.ecomexpress.in
Username: customer_api_key
Password: ****
Will be provided by Ecom Express

Pre Approved IP Address from where the

customer is going to make a request
Customer will have to provide this for Ecom Express to generate above
informa9on

 API Request for Mul9ple AWB
To access details of mul9ple airwaybill following
parameters needs to be posted to URL: hGp://
api.ecomexpress.in
Username
Password
awb (comma separated mul9ple airwaybill number)
e.g. 712345678, 712345679
should be blank if you want to query using order number

order (comma separated mul9ple airwaybill number)

e.g. 2312345678, 232434325679
should be blank if you want to query using awb number
 API Response for Mul9ple AWB
Following is Sample Expected XML output

<ecomexpress-objects version="1.0">
<object pk="1" model="awb">
<eld type="BigIntegerField" name="awb_number">700096485</eld>
<eld type="CharField" name="orderid">555525</eld>
<eld type="FloatField" name="actual_weight">0.1</eld>
<eld type="CharField" name="origin">DELHI-DEP</eld>
<eld type="CharField" name="des9na9on">MEERUT-MEE</eld>
<eld type="CharField" name="customer">Ecom Express Private Limited - 32012</eld>
<eld type="CharField" name="consignee">sandeep kumar</eld>
<eld type="CharField" name="pickupdate">25-Mar-2013</eld>
<eld type="CharField" name="status">Shipment Uploaded</eld>
<eld type="CharField" name="reason_code"/>
<eld type="CharField" name="reason_code_descrip9on"/>
<eld type="CharField" name="receiver"/>
<eld type="CharField" name="expected_date">26-Mar-2013</eld>
<eld type="CharField" name="last_update_date">06-Apr-2013</eld>
<eld type="CharField" name="delivery_date"/>
</object>
</ecomexpress-objects>
 API
Status Update

Pickup Complete / Inscan
Inscan comple9on / Ready for Bagging
Bagging completed
Shipment at HUB
Bagging Completed at HUB
Shipment at Delivery Centre
Outscan
Undelivered
Delivered / Closed
Redirec9on under new Airwaybill awb number
 API
Reason Codes list 1
(Reason codes are associated to delivered and undelivered)
Reason Codes list 2
(Reason codes are associated to delivered and undelivered)

For Status Delivered Following is the reason code 221 - Consignee Refused To Accept
999 Delivered 222 - Address Incorrect
223 - Address Incomplete
For Status Redirec9on under new Following is the reason 224 - Address Unlocatable
code 225 - Shipment Manifested - Not Received by Des9na9on
777 - RTS - Return To Shipper 226 - Holiday - Delivery on Next Working Day
227 - Residence/Oce Closed
For undelivered or in transit following reason codes are 228 - Out of Delivery Area
applicable
229 - HOLD AT LOCATION
100 - Delay in Delivery Expected 230 - Misrouted due to ECOM's Fault
101 - Shipment Detained At Origin/PPC 300 - Please Contact Customer Care
200 - Forcibly Taken By Consignee 301 - Shipment Detained/Seized by Regulatory Authority
201 - Awai9ng Consignee's Response for Delivery 302 - Shipment Damaged
202 - Correc9on Of Wrong POD Details 303 - Shipment In Transit
203 - Re-aGempt and Return 304 - Network Delay
204 - Shipment Delivered/Consignee Complains of 305 - Shipment O-loaded By Airline
Damage 306 - Flight Cancelled
205 - Redirec9on on same Air Waybill 307 - Held - Regulatory Paperwork Required
206 - Return to Origin on Same Air Waybill 308 - Held for Octroi/ Taxes
207 - Misrouted due to Shipper's fault 309 - Missed Connec9on
208 - Contents Missing 331 - Consignee requested for future delivery
209 - Consignee Refusing to Pay COD Amount 333 - Shipment Lost
210 - COD Amount Not Ready 666 - SDL - Special delivery loca9on
211 - RTO Shipment HAL as per Customer's Request 888 - Shipment Destroyed/Abandoned
212 - Consignee Out Of Sta9on 218 - Consignee Shiped from the Given Address
213 - Scheduled for Next Day Delivery 219 - Consignee Not Available
214 - Need Department Name/ Extension Number 220 - No Such Consignee At Given Address
215 - Disturbance/Natural Disaster/Strike
216 - Late Arrival/Scheduled for Next Working Day
217 - Delivery Area Not Accessible
 API Request for Single AWB scans
To access details of single airwaybill following
parameters needs to be posted to URL: hGp://
api.ecomexpress.in
Username
Password
awb (airwaybill number)
e.g. 712345678
should be blank if you want to query using order number

order (airwaybill number)

e.g. 2312345678
should be blank if you want to query using awb number
 API Response for single AWB scans
Following is XML Schema of the response of Mul9ple Request
<xs:schema xmlns:xs="hGp://www.w3.org/2001/XMLSchema" aGributeFormDefault="unqualied" elementFormDefault="qualied">
<xs:element name="ecomexpress-objects">
<xs:complexType>
<xs:sequence>
<xs:element name="object">
<xs:complexType>
<xs:sequence>
<xs:element name="eld" maxOccurs="unbounded" minOccurs="0">
<xs:complexType mixed="true">
<xs:sequence>
<xs:element name="object" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="eld" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:aGribute type="xs:string" name="type" use="op9onal"/>
<xs:aGribute type="xs:string" name="name" use="op9onal"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:aGribute type="xs:byte" name="pk" use="op9onal"/>
<xs:aGribute type="xs:string" name="model" use="op9onal"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:aGribute type="xs:string" name="type" use="op9onal"/>
<xs:aGribute type="xs:string" name="name" use="op9onal"/>
<xs:aGribute type="xs:string" name="to" use="op9onal"/>
<xs:aGribute type="xs:string" name="rel" use="op9onal"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:aGribute type="xs:int" name="pk"/>
<xs:aGribute type="xs:string" name="model"/>
</xs:complexType>
</xs:element>
</xs:sequence>
 API Tes9ng Access

For the test purpose you can use the following example.

username: ecom
password: qw3nc76d0u
Server: hGp://ecomapi.prtouch.com/

This link is using GET and POST (On the main site you will have to use post) for
you to implement your updates.

e.g.
hGp://ecomapi.prtouch.com/track_me/api/mawb/?
awb=700096481,700096482,700096483,700096484,700096485,700096486,7000
96487,700096488,700096489,700096490&order=&username=ecom&password=
qw3nc76d0u

The output is in XML format.