Push API Implementation Document

Status Tracking

BLUE DART EXPRESS LIMITED

Head Office, Mumbai

Status Tracking
Version History
Version Date Changes Author

0.1 Beta Mar-2017 Beta testing Jayesh A

Live May-2018 Push API Janhavi

Table of Contents
Scope: ............................................................................................................................................................................................ 2

Status Tracking Structure: ............................................................................................................................................................. 4

Partnership Setting: ........................................................................................................................................................................ 7

Blue Dart Infra Details: ................................................................................................................................................................. 7

Security Method: ........................................................................................................................................................................... 8

Contact Details: ............................................................................................................................................................................. 9

Scope:
This transaction set can be used by a transportation carrier to provide shippers, consignees, and their agents with
the status of shipments in terms of dates, times, locations, route, identifying numbers, and conveyance.

The Status Tracking data will be periodically extracted from the Operations ERP and using web services, the
data in a Json format will be pushed to the customer web server.

There will be three retry mechanism to resend the data in case of any exception encountered during the data
transfer. The exception could be of the nature of data content, network related, Infra related etc.
Status Tracking Structure:
Please find below the list of fields which would be used in the Status Tracking transaction.
Bloc k Fields Data Type Description Sample Values Lite Plus Advanced

StatusTracking

Shipment
SenderID Character (4) The Courier being used BDEL Yes Yes
for transport
ReceiverID Character (20) Identifier of business SBI Yes Yes
unit
WaybillNo Character (12) Waybill or Track 40950937123 Yes Yes Yes
Number
RefNo Character (20) Customer's IN001-1385604480 Yes Yes Yes
Reference for the
Package
Prodcode Character (1) The service offered by D Yes Yes
the Courier (D/A/E)

SubProductCode Character (1) Sub offering of the Yes Yes

Service ex. Cod,
Prepaid (C/P)
Feature Character (1) Any Specific Yes Yes
Feature ex. TDD, Dart
Plus (lite product)
(T/N/L)
Origin Character (25) Origin name where the Yes Yes
shipment is picked
MUMBAI
OriginAreaCode Character (3) 3 letter Origin area code BOM Yes Yes
from where the
shipment is picked

Destination Character (25) Destination name where Yes Yes

the delivery happens
GURGAON
DestinationAreaCode Character (3) 3 letter destination Yes Yes
location code where the
delivery happens

GGN
PickUpDate DATE Shipment Pickup date Yes Yes
(dd-mmyyyy)
02-06-2017
PickUpTime Character (4) Time of pick up ( 24 1800 Yes Yes
hour format,i.e.
2359)
ExpectedDeliveryDate DATE Expected Delivery Date Yes Yes
(dd-mmyyyy)
02-06-2017
Weight NUMBER(7,2) Shipment Weight 0.5 Yes Yes

ShipmentMode Character (3) Forward and reverse F- Forward , R- Yes Yes

shipment identifier Reverse

DynamicExpectedDeliveryDat e DATE Dynamic Expected 20-09-2018 Yes

Delivery Date
(ddmmyyyy)

SpecialInstruction Character(50) Special comments NO NO

regarding scan Yes
CustomerCode Character (6) Customer Code 123456
Yes Yes Yes
Scans

ScanType Character (2) Status group are DL Yes Yes Yes

DL - Closure, RT- RTO,
RD-
Redirect, UD-
Undelivered
ScanGroupType Character (2) Status type T - Status , S T Yes Yes Yes
- Scan , RT- Return
shipment Status,

RS - Return shipment
scan
ScanCode Character (3) Status Codes defined for 0 Yes Yes Yes
activities

Scan Character (50) Status description SHIPMENT Yes Yes Yes

DELIVERED
ScanDate DATE Status Date Yes Yes Yes
(ddmmyyyy) 03-06-2017
ScanTime Character (4) Status Time ( 24 hour Yes Yes Yes
format,i.e. 2359)
1127
ScannedLocationCode Character (3) 3 letter Event location ADR Yes Yes Yes
code
ScannedLocation Character (25) Location description ADARSH Yes Yes

ScannedLocationCity Character (20) Location City MUMBAI Yes Yes

description
ScannedLocationStateCode Character (2) Location belongs to MH Yes Yes
which State
StatusTimeZone Character (4) Time Zone , IST UTC,IST Yes Yes

Comments Character(50) Special comments Yes Yes

regarding scan
StatusLatitude Character(25) Latitude of the Event Yes
Location
StatusLongitude Character(25) Longitude of the Event Yes
Location
SorryCardNumber Character(25) Sorry card number
Yes
ReachedDestinationLocation Character(1) Shipment reached to last Y/N
mile lcoation
Yes
SecureCode Character(6) Secure code OTP 123456 Yes

DeliveryDetails IF Group = DL
(condition: Only
For Delivered
Case)
ReceviedBy Character (30) Name of the person who PRABHAT Yes Yes Yes
accepted the delivery
(Only For Delivered
Case)

Relation Character (30) Relation to the self Yes Yes

Intented
Package's
Recipient
IDtype Character (2) ID Proof Shown PC Yes Yes
for Securitized
Shipments
 IDNumber Character (20) ID Number of the Above AAAAAAAAAAAAA Yes Yes
ID

IDDescription Character (30) ID Descriotion Pan Card Yes Yes

IDImage Image taken Yes

during
BLOB Delivery
Signature BLOB Signature Proof Yes

SecurityCodeDelivery Delivery done based

on Security Code for
secure delivery
Character(1) shipments Y/N Yes Yes Yes

QC Yes Yes

Questions

item_id Character() Item ID Yes

question_id Character() Question ID Yes

question_description Character() Question Description Yes

question_value Character() Question Value Yes

expected_ans Character() Expected value of answer Yes

for the above question

actual_ans Character() Actual value that was a

provided for this scan

Type Character (1) Flag to identify QC pass P/F Yes Yes

or Failure cases. P - QC
pass , F - QC failure
case

Reason Character (30) Reason for failure Yes Yes

Pictures Pictures taken while QC Yes Yes

- Multiple in a subset
BLOB array

Reweigh If the scan for Reweigh

Group = RW
(Condition) (Array)
MPSNumber Character (16) PieceID Yes

RWActualWeight NUMBER(7,2) Weight from the WDL 0.5 Yes

RWLength NUMBER(5) Length from WDL Yes

RWBreadth NUMBER(5) Breadth from WDL Yes

RWHeight NUMBER(5) Height from WDL Yes

NUMBER(7,2) Calculated Volumetric 0.5 Yes

RWVolWeight weight
 CallLogs Direct Calls , Call Bridge
, SMS
Message Character (300) Call Status Yes

LogDate DATE Log Date (ddmm-yyyy) Yes

03-06-2017
LogTime Character (4) Log Time ( 24 hour Yes
format,i.e. 2359)
1127

POD DC Images POD hard copy image

and delivery Chelan
images

PODImage BLOB Hard copy image Yes

DCImage Delivery Chelan Image Yes

BLOB
Number of images
including DC images
Imagesequence NUMBER(2) Yes

RWImage If the scan for Reweigh

Group = RWI
(Condition) (Array)
MPSNumber Character (16) PieceID Yes

RWImageURL Character (100) Reweigh Image URL Yes

Lite will not have header detail splits… All are single record case.

Partnership Setting:
To establish a partnership connection between both organization, there are certain details which needs to be
shared and configured to ensure there is sufficient security as well as controls are maintained for this automated
data transfer.

Blue Dart Infra Details:

Blue Dart Source IPs

Production 165.72.200.13, 199.40.127.49, 156.137.9.65
UAT Testing 165.72.200.13, 199.40.127.49, 156.137.9.65

Blue Dart IPs needs to be white listed at the Firewall at Customer end.
Customer Details:
Customer On-boarding Profile Details

Organisation Blue Dart Express Ltd Customer

ID BDEL Customer Name

Business Unit BDEL Customer Name

Custo mer's Web Server Details

Ports
URL
Production
http

Production
https

UAT
http
UAT
https
Web Server Certificate Authority

Security Method:

Authentication Mode (Choose One)

[ ]
Only User-ID & Password

[ ]
Authentication based on License Key

[ ]
Time Based Token

Only User-ID & Password

Test Credentials:
User ID: stagingID
Password: To be Provided
Live Credentials:

User ID: LiveID

Password: To be Provided

Authentication based on License Key

Test Credentials:
client-id: stagingID
License Key: To be Provided
Live Credentials:

client-id: LiveID
License Key: To be Provided

Time Based Token

Test Credentials: Token will sent in request header in each request.

client-id: stagingID
client-secret: hg56df56gf2j24we28fv8j6k2d32ds
email: [email protected]
password: stagepass

Live Credentials: Token will sent in request header in each request

client-id: CustomerID
client-secret: g5s6h575d2f6sh586k4d65g4j648l12d323yh5
email: [email protected]
password: LivePassword

Contact Details:
Customer’s Contact Details

Contact Name (Technical 1)

Contact Number (Technical 1)

Email Address (Technical 1)

Contact Name (Technical 2)

Contact Number (Technical 2)

Email Address (Technical 2)

Contact Name (Business)

Contact Number (Business)

Email Address (Business)

Customer Country

Sample Payload:
Sample Files (Push API Advance)
{
"statustracking": [
{
"Shipment": {
"SenderID": "Bluedart",
"ReceiverID": "IMAGINEMARKETING",
"WaybillNo": "81191480263",
"Origin": "VASAI",
"OriginAreaCode": "BOM",
"Destination": "NAVI MUMBAI",
"DestinationAreaCode": "IMG",
"PickUpDate": "10-04-2023",
"PickUpTime": "1628",
"ShipmentMode": "R",
"ExpectedDeliveryDate": "01-01-0001",
"Feature": null,
"RefNo": "31912682",
"Prodcode": "A",
"SubProductCode": "P",
"Weight": "0",
"DynamicExpectedDeliveryDate": "",
"CustomerCode": "449116",
"Scans": {
"ScanDetail": [
{
"Scan": "PICK UP SCAN ON FIELD",
"ScanCode": "015",
"ScanGroupType": "S",
"ScanDate": "10-04-2023",
"ScanTime": "2327",
"ScannedLocation": null,
"ScanType": "UD",
"Comments": "1",
"ScannedLocationCode": "ADR BRANCH ETAIL",
"ScannedLocationCity": "MUMBAI",
"ScannedLocationStateCode": "MH",
 "StatusTimeZone": "IST",
"StatusLatitude": "19.1217843",
"StatusLongitude": "72.8684903",
"SorryCardNumber": null,
"ReachedDestinationLocation": "N",
"SecureCode": null
}
],
"DeliveryDetails": {
"IDNumber": null,
"IDType": null,
"ReceivedBy": null,
"Relation": null,
"SecurityCodeDelivery": null,
"Signature": null,
"IDImage": null
},
"PODDCImages": {
"PODImage": [
"{base64}"
],
"DCImage": [
"{base64}"
]
},
"QC": {
"Questions": [
{
"item_id": "279",
"question_id": "boat06",
"description": "Is the product in good condition?",
"question_value": "Yes",
"expected_ans": "Y",
"actual_ans": "N"
},
{
"item_id": "279",
"question_id": "boat01",
"description": "Is the product model matching the image shown?",
"question_value": "Yes",
"expected_ans": "Y",
"actual_ans": "N"
},
{
"item_id": "279",
"question_id": "boat02",
"description": "Is the Color Matching?",
"question_value": "Yes",
"expected_ans": "Y",
"actual_ans": "N"
},
{
"item_id": "279",
"question_id": "boat10",
"description": "Is there a box packaging available? (any type of box)",
"question_value": "Yes",
"expected_ans": "Y",
 "actual_ans": "N"
},
{
"item_id": "279",
"question_id": "boat04",
"description": "Is the ear net (net in the ear piece) in good condition?",
"question_value": "Yes",
"expected_ans": "Y",
"actual_ans": "N"
}
],
"Remarks": null,
"Pictures": [
"{base64}",
"{base64}"
],
"Result": "P"
},
"Reweigh": {
"MPSNumber": null,
"RWActualWeight": null,
"RWLength": null,
"RWBreadth": null,
"RWHeight": null,
"RWVolWeight": null
},
"RWImage": [
{
"MPSNumber": null,
"RWImageURL": null
}
],
"CallLogs": {
"Message": null,
"LogDate": null,
"LogTime": null
}
}
}
}
]
}

QC Master
QC Reason Code Reason Description

101 Number of items not matching

 102 Item used/ damaged or in bad condition

103 Accessories/ parts not available

104 Brandbox/ Invoice not available

105 Not the same product

106 IMEI Number/ Serial Number not matching

107 Return Reason not matching

Image Transmission codes

Status
Status Type Code Description

T POD Pod Image [ pod/dc Both , multiple Images can be pushed]

T SIG Signature image [ ID Image and Signature Image to be pushed]

S QC RETURN PICKED [RVP QC images Success]

T QC RETURN REJECTED [ RVP QC images failure ]