Webhook Integration Guide

Version 1.1

2
Table of Contents
Contents

SHIPMENT STATUS API (PUSH)..............................................................................................................................4

Introduction ................................................................................................................................................... 4
API Details ...................................................................................................................................................... 4
Required Information from customer……………………………………………………………………………………………………………4
Payload………………………………………………………………………………………………………………………………………………………4-5
Sample Response: Success Case ...................................................................................................................... 6
Failure Responses:.......................................................................................................................................... 6
Request Parameters.…………………………………………………………………………………………………………………………………..6-7
Status codes………………………………………………………………………………………………………………..…………………………………8
Reason codes.………………………………………………………………………………………………………………..…………………………9-12

3
 SHIPMENT STATUS API (PUSH)
Introduction
Push API is used to push status changes for shipments as and when any update happens in Ecom system.
This is achieved by pushing individual scans to web services developed and maintained by customers. To
consume the status information, Customers must develop and maintain web service.

This API validation is based upon the username/password or Key.

API Details
Will be provided by Client to Ecom Express.

Required Information from customer

HTTPS Method: POST

Header to be consumed,

Key: - x-webhook-version
Value: - 2.0

URL: Provided by Customer, example https://Customerportal.com

Authentication:
1. Basic Authentication: - It is a simple yet effective method that requires your application to include a
username and password with each API request.
2. Generic Authentication: - Passing your username and password as a text in headers or query param.
3. Static secret key-based Authentication: - Static key to be shared which we will be passing in the header or
query param.

Payload

{
"awb": "115927640",
"order_id": "c-order-1",
"date_time": "2022-11-21 13:17:42",
"edd": "2022-11-24",
"status": "Delivered",
"status_code": "113",
"reason": "",
"reason_code": "",
"collectable_amount": "230",
"fe_remarks": " Delivered",

4
 "pickup_date": "27-Feb-2023",
"current_state": "Gurugram",
"current_city": "Gurugram",
"origin_state": "Gurugram",
"origin_City": "Gurugram",
"destination_state": "Gurugram",
"destination_city": "Gurugram",
"current_sc": "DLH",
"current_pincode": "111111",
"destination_pincode": "111111",
"latitude": "21.6570702",
"longitude": "85.5883818",
"employee_name": "None",
"employee_code": "",
"employee_number": "",
"ref_awb": "",
"return_pickup_barcode_id": "12345678987654",
"otp_eligible": "Yes/No",
"otp_status": "Verified/Skipped/Not-verified",
"otp_type": "Cancellation/Delivery/Reschedule/Reverse Pickup",
"otp": "For future reference",
"otp_datetime": "Forfuturereference",
"otp_email": "Forfuturereference",
"otp_mobile": "Forfuturereference",
"product_type": "ppd/cod/rts/rev/rqc",
"shipment_type": "Forward/Reversepickup/Return",
"digital_payment": "Yes/No",
"actual_weight": ".200",
"sign_image": "",
"qc_list": [
{
"qccheckcode": "GEN_ITEM_DESC_CHECK",
"value": "qcvalue",
"match": "1",
"image": "2023/Oct/27/506065374_17649_QC_GEN_ITEM_DESC_CHECK.png"
},
{
"qccheckcode": "GEN_ITEM_NEW_CONDITION_CHECK",
"value": "qc value ",
"match": "0",
"image": "2023/Oct/27/506065374_17649_QC_GEN_ITEM_NEW_CONDITION_CHECK.png"
}
]
}

5
Sample Response: Success Case
{
"awb": "AWB_NUMBER",
"status": true,
"order number": 1898982
}

Failure Responses:
{
"awb": "AWB_NUMBER",
"status": false,
"reason": Reason,
"order number": 1898982
}

Request Parameters

Field Data type Description

awb Integer Airwaybill number
order_id Text Order id received in manifestation
Event occurred date and time.
date_time datetime (“yyyy-MM-dd'T'HH:mm:ss”)
edd Date Estimate date of delivery (‘yyyy-MM-dd')
status_code Int Shipment status code (Attached below)
status Text Shipment status description (Attached below)
reason_code Int Shipment reason code (Attached below)
reason Text Shipment reason description (Attached below)
Amount collected at the time of delivery in COD
collectable_amount double Shipments in rs.
fe_remarks Text Fe remarks
pickup_date Dare Shipment pickup date(‘yyyy-MM-dd')
current_state Text Shipment current state
current_City Text Shipment current city
origin_state Text Shipment origin state
origin_City Text Shipment origin city
destination_state Text Shipment destination state

6
Field Data type Description
destination_City Text Shipment destination city
current_sc Text Shipment current SC
current_pincode Int Shipment current pincode
destination_pincode Int Shipment destination pincode
latitude Double Latitude (geo codes)
longitude Double Longitude (geo codes)
employee_Name Text Field executive name
employee_code Int Field executive code
employee_number Int Field executive phone number
ref_awb Int Reference/return airwaybill number for RTS shipments
return_pickup_barcode_id Int Package id for return shipments
otp_eligible Text OTP eligible (“Yes/No") based on
"OTP_REQUIRED_FOR_DELIVERY” flag under additional
info in manifestation
otp_status Text "Verified/Skipped/Not verified"
otp_type Text "Cancellation/Delivery/Reschedule/Reverse Pickup"
otp Int For future reference
otp_datetime Date For future reference
otp_email Text For future reference
otp_mobileno Int For future reference
product_type Text "ppd/cod/rts/rev/rqc"
shipment_type Text "Forward/Reverse pickup/Return"
digital_payment Text "Yes/No"
actual_weight Double Weight of shipments in Kg.
sign_image String POD signature image.
qc_list List List of QC parameters mentioned below
qccheckcode Text Qc check codes passed in Rqc shipments
value text Value passed in manifestation
match Boolean QC match status [ 0 (false) and 1 (True)]
image String Image captured at the time of QC

7
Status codes

Status Reason Journey Applicable

Status Description
Code Applicable (Forward/Reverse pickup/Return)

101 Soft data uploaded No Forward/Reverse pickup

106 Pickup cancelled by ecom Yes Forward/Reverse pickup
107 Pickup cancelled by shipper Yes Forward/Reverse pickup
102 Pickup assigned No Forward/Reverse pickup
103 Out for pickup No Forward/Reverse pickup
104 Pickup failed Yes Forward/Reverse pickup
105 Pickup rescheduled for next day No Forward/Reverse pickup
119 Pickup redirected Yes Forward/Reverse pickup
118 Pickup unassigned No Forward/Reverse pickup
115 Shipment lost Yes Forward/Reverse pickup/Return
116 Shipment damaged Yes Forward/Reverse pickup/Return
117 Destroyed Yes Forward/Reverse pickup/Return
108 Field pickup done No Forward/Reverse pickup
109 Origin facility inscan Yes Forward/Reverse pickup
110 Bagged No Forward/Reverse pickup/Return
122 Shipment inscan at location Yes Forward/Reverse pickup/Return
123 Shipment debagged at location Yes Forward/Reverse pickup/Return
124 Bag inscan at location Yes Forward/Reverse pickup/Return
125 Bag added to connection No Forward/Reverse pickup/Return
126 Departed from location Yes Forward/Reverse pickup/Return
133 DC inscan No Forward/Reverse pickup/Return
120 DRS created No Forward/Reverse pickup/Return
121 Out for delivery No Forward/Reverse pickup/Return
112 Undelivered Yes Forward/Reverse pickup/Return
113 Delivered No Forward/Reverse pickup/Return
114 Returned Yes Return
138 Misrouted due to ecom's fault Yes Forward/Reverse pickup/Return
135 Mass update Yes Forward/Reverse pickup/Return
137 Shipment misroute - delay in delivery expected Yes Forward/Reverse pickup/Return
136 Sal tally scan on shipment No Forward/Reverse pickup/Return
139 Bag_recevied_after_cut-off Yes Forward/Reverse pickup/Return
129 OFD lock Yes Forward/Reverse pickup
130 OFD lock revoked Yes Forward/Reverse pickup
131 DMG lock No Forward/Reverse pickup/Return
132 DMG lock revoked No Forward/Reverse pickup/Return
127 RTO lock No Forward
128 RTO lock revoked No Forward

8
Reason codes

Reason Undelivered Pickup NDR

Reason Description
Code eligible eligible eligible
RTO shipment hal as per customer's request /awaiting RTS
211 No No No
processing
222 Address incorrect Yes No Yes
224 Address unlocatable Yes No Yes
229 Hold at location No No No
230 Misrouted due to ecom's fault No No No
235 Bulk order by consignee No No No
236 Hold at location - consignee will self-collect No No No
241 Otp/secure package delivery validation failed Yes Yes Yes
302 Shipment damaged No No No
304 Network delay No No No
310 Soft data uploaded - shipment not picked up No Yes No
312 DMG lock - tat breach No No No
313 DMG lock - life cycle breach No No No
314 DMG lock - damage No No No
315 DMG lock - system delivered but physically available No No No
316 DMG lock - product mismatch No No No
326 Shipment cancelled after max unsuccessful pickup attempts No Yes No
331 Consignee requested for future delivery No No No
332 Shipment under investigation No No No
333 Lost in ecom network No No No
402 Customer requested to reschedule pickup No Yes No
403 No shipment today No Yes No
404 Pickup cancelled by shipper No Yes No
405 Pickup not done-pickup location not served No Yes No
406 Pickup wrongly registered by shipper No Yes No
407 Customer/contact person not available No Yes No
408 Pickup missed-staff reached late No Yes No
409 Shipment without packing Yes Yes Yes
411 Customer not aware about the pickup No Yes No
413 Pickup already done through other courier No Yes No
414 Customer wants confirmation from shipper No Yes No
415 Customer wants hand to hand replacement/refund No Yes No
416 Pickup misrouted No Yes No
417 Customer number not reachable/switched off No Yes No
418 C`nee shifted, phone num wrong No Yes No
419 Three attempts made, follow up closed No Yes No
420 Duplicate pickup No Yes No
422 Customer does not want to return the product No Yes No
425 Customer refused to handover No Yes No
426 Reverse pickup failed because of qc checks failed No Yes No

9
427 Pickup cancelled due to larger product size No Yes No
430 Consignee initiated cancellation No Yes No
504 Type_change_from_cod_to_ppd No No No
505 Cod_value_updated No No No
506 Declared_value_updated No No No
507 Consignee_mobile_updated No No No
509 Consignee_address_updated No No No
600 RTS_reversal No No No
702 Seller_refusal_no_claim No No No
777 Shipment returned No No No
840 Network delay - no entry / political disturbance No No No
841 Network/connection delay due to tech issue No No No
842 Load delay due to vvip movement. No No No
1225 Delivery attempt not to be made No No No
12241 Delivery attempt to be made - inbound cc instructions No No No
12242 Delivery attempt to be made - outbound cc/dccs instructions No No No
12243 Delivery attempt to be made - kas instructions No No No
12244 Delivery attempt to be made - customer instructions No No No
12245 Delivery attempt to be made - fe instructions No No No
12246 Delivery attempt to be made - consignee feedback No No No
12247 Delivery attempt to be made - escalations No No No
20001 Forcibly taken by consignee - refused to pay cod amount Yes No No
20002 Forcefully opened by customer and returned Yes No No
20003 Shipment snatch by consignee No No No
20701 Misroute due to wrong pincode given by customer No No No
21001 Cod amount not ready Yes No Yes
21002 Order already cancelled No Yes No
21003 Cod amount incorrect as per customer Yes No No
21004 Customer wants open delivery Yes No No
21501 Shipment cannot be attempted - due to strike / bandh/ elections Yes Yes Yes
21502 Shipment cannot be attempted - due to natural clamity Yes No Yes
21601 Late arrival-misconnection/after cut off No No No
21602 Improper bagging No No No
21603 Without flagging No No No
21701 No entry area / cantonment Yes Yes Yes
22101 Seller refused to accept - want open delivery Yes No No
22102 Seller refused to accept - capacity constraint of customer Yes No No
22103 Seller refused to accept - outer packaging damaged Yes No No
22104 Seller refused to accept - brand box damaged Yes No No
22105 Seller refused to accept - content missing Yes No No
22106 Seller refused to accept - interchange shipment Yes No No
22107 Seller refused to accept - tat breached Yes No No
22108 Seller refused to accept - technical issue at seller end Yes No No
22109 Seller address closed Yes No No
22111 Seller address wrong/incomplete Yes No No

10
22301 Wrong or incomplete address No Yes No
22303 No such consignee at given address Yes Yes Yes
22701 Shipment attempted - residence closed No Yes No
22704 Customer refused delivery at doorstep Yes No Yes
22705 Could not be delivered - vehicle break down / accident Yes No Yes
22801 Customer address out of delivery area Yes No No
22901 Customer requested for self collection No No No
22903 Holiday / weekly off - delivery on next working day Yes Yes Yes
23101 Customer out of station Yes Yes Yes
23102 Customer not available at office Yes No Yes
23201 Consignee/location not accessible due to covid-19 No No No
23202 Shipment cannot be attempted due to covid-19 No No No
23701 Case with legal team No No No
23801 Case with insurance team No No No
24001 Shipment hold at origin -due to soft data not available No No No
24002 Shipment hold at origin -due to poor packaging /slp to check No No No
24003 Shipment hold at origin -invoice missing No No No
24202 Cannot be attempted - due to capacity/time constraint Yes No Yes
24204 Delivery attempted - otp not available Yes No Yes
24455 Capacity constraint at customer No No No
30101 Shipment detained/seized by regulatory authority No No No
30201 Shipment contains liquid item No No No
30202 Shipment damage - contains fragile item No No No
30203 Damaged - perishable item No No No
30204 Shipment damage No No No
30401 Network delay - traffic jam No No No
30402 Network delay - heavy rain No No No
30403 Network delay - due to dense fog No No No
30404 Network delay - flight delay No No No
30405 Network delay - due to regulatory compliance No No No
30406 Network delay - vehicle met with accident No No No
30407 Network delay -vehicle broke down No No No
30408 Network delay -strike bandh No No No
30409 Network delay -flight cancelled No No No
30410 Network delay -capacity constraint No No No
30411 Network delay-due to heavy rain/flood No No No
30412 Flight delay-due to bad weather/due to technical snag No No No
30413 Shipment hold - no e-waybill No No No
30414 Network delay - load hold by hub due to less volume No No No
30415 Network delay - load hold by hub due to spill over No No No
30501 Shipment offloaded by airlines -banned commodity No No No
30502 Shipment offloaded by airlines - capacity constraints No No No
30503 Shipment offloaded by airlines - flight cancelled No No No
30505 Dangerous goods/banned commodity-hold with the airlines No No No
34601 Capacity/manpower issue at location No No No

11
32103 Shipment cannot be attempted due to dc backlog No No No
32104 Shipment cannot be attempted due to dc overallocation No No No
32105 Vehicle constraint No No No
32501 Branded package id mismatch/incorrect No No No
32502 Unable to scan barcode Yes No Yes
33301 Lost from service location No No No
33303 Lost from mother bag No No No
33308 Lost & fir registered No No No
33401 Cross border shipment No No No
34602 Network vehicle not reported No No No
34603 Capacity/manpower issue at hub No No No
34801 Lost- recovery initiated debit pending No No No
34802 Lost_full recovery done No No No
34803 Lost_no recovery_not enough payable No No No
34804 Lost - unable to recover from vendor No No No
34805 Lost - partial recover from employee No No No
34806 Lost - partial recovery_vendor not aligned No No No
35003 OFD lock kas/shipper No No No
35004 OFD lock cs/recon No No No
35006 OFD lock - consignee request No No No
88801 Shipment contains liquid item No No No
88802 Shipment destroyed - contains liquid item No No No
88803 Shipment destroyed - contains fragile item No No No
88804 Shipment destroyed - empty packet No No No
88805 Shipment destroyed - food item No No No
88806 Liquidated at dc on shipper instruction without claim No No No
88807 Shipment destroyed No No No
88808 Liquidated at DMG on shipper instruction without claim No No No
1320 Pickup failed, shipment picked up by other courier No Yes No
1380 Pickup failed, road blocked/premise inaccessible No Yes No

----------End of the Document---------

Thank You!

12