Developers Guide for Integrating BLUE DART API 2018

Table of Contents
Version History 3
Getting Started: Shipping API 4
SOAP Introduction 5
SOAP Building Blocks 6
Using Shipping Services API 7
Structure Diagrams 8
Finders 9
Location Finder 9
Methods used in Location Finder 9
Detailed Description of each methods used in Location Finder 10
Transit Time 13
Methods used in Transit Time Finder 13
Detailed Description of each methods used in Transit Time Finder 13
Pickup 14
Pickup Registration 14
Methods used in Pickup Registration 15
Detailed Description of each methods used in Pickup Registration 15
Cancel Pickup Registration 17
Waybill Generation 20
Methods used in Waybill Generation 20
Detailed Description of each methods used in Waybill Generation 20
Detailed Description of Update EwayBill 38
Detailed Description of WayBill Cancelation 39
ALTInstruction Update 39
Methods used in alt Instruction 40
Master Download 42
Methods used in Master download 42
Detailed Description of each methods used in Master download 43
Common object 44
Common object details 44
User Profile 44
Common Master Details 44

1|Page
Developers Guide for Integrating BLUE DART API 2018

Country Master 44
State Master 45
Products Master 47
Pack Type Master 48
Product Description Master for Intl Ecom CSB 49
Postal code format for Intel E-Comm. 49
Incoterm code master 49
Unit master 50
Currency code master 52
European Union Country master 53
DHL Country Region code master 54
Shipping API Client Application 59
Prerequisites of using Shipping API demo client 59
Simple Coding Demo of Client Application in Visual Studio 59
Excel File import 64
Common Terminology 66
Detailed description of common terminology used in this document 66
Shipping API Demo URLs 66
Pin Code Finder 66
Transit Time 66
Pickup Registration 66
Cancel Pickup Registration 66
Waybill Generation 66
ALTInsruction Update 66

2|Page
Developers Guide for Integrating BLUE DART API 2018

Version History

Version Date Changes

0.1 Beta Aug-2013 Beta testing (Tracking)
0.2 Beta Oct-2013 Beta Testing (Pickup Registratiom)

0.3 Beta Oct-2013 Beta Testing (Cancel Pickup)

0.4 Beta Nov-2013 Beta Testing (Waybill Generation)

0.5 Beta Dec-2013 Beta Testing (Waybill Generation with Prin)

0.6 Live Feb -2014 Demo & Live Version

0.7 Live Jul - 2014 Basic Http & WsHttp ( Soap 1.2 is added)
Multiple Waybill Generation
1.7 Live Jul -2015 Incremental Master download.
Multiple Waybill generation request.
Waybill number to be pushed in pickup
registration.
Cancel Waybill/RTO Compulsory.
1.8 Live Jul-2016 Reverse Pickup Features
2017 E-waybill Features
2018 Alternate Instructions API
2019 Open RVP
Cross Border Features
DOD (Demand Draft on Delivery)
FOD (Freight on Delivery) Services
OTP based Delivery Feature
Exchange Product Feature
1.9 Jun-2019 Open RVP Enhancement

1.9 Dec-2019 Alt instruction: Escalation Delivery “ED”

Getting Started: Shipping API

3|Page
Developers Guide for Integrating BLUE DART API 2018

Connectivity diagram

The Blue Dart Shipping API (Application Programming Interface) provides you with a wide
range of functionalities which enables your systems and applications to integrate directly
with Blue Dart’s systems in an easy and automated way. The APIs are built based on SOAP
(Simple Object Access Protocol) providing a secure channel of communication, as all web
calls are made through secured HTTPS. (This is also available via unsecure HTTP mode for
customers who want this level of access)

4|Page
Developers Guide for Integrating BLUE DART API 2018

SOAP Introduction
SOAP is a simple XML-based protocol to let applications exchange information over HTTP.

Or more simply: SOAP is a protocol for accessing a Web Service.

What You Should Already Know

Before you study SOAP you should have a basic understanding of XML and XML
Namespaces.

If you want to study these subjects first, please read our XML Tutorial.

What is SOAP?

SOAP stands for Simple Object Access Protocol

SOAP is a communication protocol
SOAP is for communication between applications
SOAP is a format for sending messages
SOAP communicates via Internet
SOAP is platform independent
SOAP is language independent
SOAP is based on XML
SOAP is simple and extensible
SOAP allows you to get around firewalls
SOAP is a W3C recommendation

Why SOAP?
It is important for application development to allow Internet communication between
programs.

Today's applications communicate using Remote Procedure Calls (RPC) between objects
like DCOM and CORBA, but HTTP was not designed for this. RPC represents a compatibility
and security problem; firewalls and proxy servers will normally block this kind of traffic.

A better way to communicate between applications is over HTTP, because HTTP is

supported by all Internet browsers and servers. SOAP was created to accomplish this.

SOAP provides a way to communicate between applications running on different operating

systems, with different technologies and programming languages.

5|Page
Developers Guide for Integrating BLUE DART API 2018

SOAP Building Blocks

A SOAP message is an ordinary XML document containing the following elements:

An Envelope element that identifies the XML document as a SOAP message

A Header element that contains header information
A Body element that contains call and response information
A Fault element containing errors and status information
All the elements above are declared in the default namespace for the SOAP envelope:

http://www.w3.org/2001/12/soap-envelope

and the default namespace for SOAP encoding and data types is:

http://www.w3.org/2001/12/soap-encoding

Syntax Rules
Here are some important syntax rules:

A SOAP message MUST be encoded using XML

A SOAP message MUST use the SOAP Envelope namespace
A SOAP message MUST use the SOAP Encoding namespace
A SOAP message must NOT contain a DTD reference
A SOAP message must NOT contain XML Processing Instructions

6|Page
Developers Guide for Integrating BLUE DART API 2018

Using Shipping Services API

• The Shipping Services API uses a Web Service Definition Language (WSDL) that can be
downloaded at

https://netconnect.bluedart.com/Ver1.9/ShippingAPI/Finder/ServiceFinderQuery.svc?ws
dl

this will enable the developers to add reference to the web service in their code.

• The user must be registered at http://www.bluedart.com with a valid user name and
password and must have a tracking api license key.

• Sample Codes is available in C# and can be downloadable at

http://netconnect.bluedart.com/samples/

http://netconnect.bluedart.com/samples/Dotnet/ShippingAPItestClientsetup.zip
Dotnet http://netconnect.bluedart.com/samples/Dotnet/ShippingAPItestClientsetup_64bit.zip
Java http://netconnect.bluedart.com/samples/Java/ShippingAPIJavaClientineclipse.zip
PHP http://netconnect.bluedart.com/samples/Php/PHPservice.zip
Documen
t http://netconnect.bluedart.com/samples/Document/BlueDartAPIService.docx

Users are free to use any development tool provided these tools support the WSDL and
messages conform to the standards and structure required. However the preferred
programming languages for client implementations are:

 Visual Basic
 C#
 Java

7|Page
Developers Guide for Integrating BLUE DART API 2018

Structure Diagrams

netconnet.bluedart.com

Pincode Master Alt Instuction

Finders Pickup Waybill Download

Pickup WayBill
Transit Pickup WayBill
Pincode Registratio Generatio Cancelation
Time n Cancel
n

8|Page
Developers Guide for Integrating BLUE DART API 2018

Finders
Location Finder
The Location Finder provides you with information on locations serviced by Blue Dart. It also outlines
the services available for each location. This service can be used by the customer to be better
advised on the serviceability and reach of Blue Dart locations. This query input is based on pin code.

Service information:

WSDL : https://netconnect.bluedart.com/Ver1.9/ShippingAPI/Finder/ServiceFinderQuery.svc?wsdl

Methods used in Location Finder

SR Method Name Return Type Input Values

No
1 GetServicesforPincode ServiceCenterDetailsReference pinCode,
profile
2 GetServicesforProduct PinCodeServiceDetailsReference pinCode,
pProductCode,
pSubProductCode
profile
3 GetServicesforPincodeAnd PinCodeServiceLocationDetailsReference pinCode,
Product ProductCode,
SubProductCode,
PackType,
Feature
profile

9|Page
Developers Guide for Integrating BLUE DART API 2018

Detailed Description of each methods used in Location Finder

GetServicesforPincode :This method will return information about all types of services provided by
Blue Dart for requested pin code.
Request

Parameters Data Require Length Allowed Description

Name Type Values
pinCode String Y 6 0-9 Pin code
Profile Object Y Client details, profile details are given in
common objects sheet.
Response :

Parameters Name Data Type Description

ServiceCenterDetailsReference Object Return service detail object for a pin code

ServiceCenterDetailsReference Definition:

Field Name Data Type Length Allowed Description

Values
PinCode string 6 0-9 Pin Code
PincodeDescription string 25 a-z,A-Z,0-9 Pin code location description
AreaCode string 3 A-Z Area code of pin code
ServiceCenterCode string 3 A-Z Service centre code of pin code
DomesticPriorityInbound string 1 Y/N Domestic Priority Inbound service
DomesticPriorityOutbound string 1 Y/N Domestic Priority Outbound Service
ApexInbound string 1 Y/N Dart Apex Inbound service
ApexOutbound string 1 Y/N Dart Apex outbound service
GroundInbound string 1 Y/N Surface Inbound service
GroundOutbound string 1 Y/N Surface Outbound Service
eTailCODAirInbound string 1 Y/N eTail COD Apex Inbound Service
eTailCODAirOutbound string 1 Y/N eTail COD Apex Outbound Service
eTailCODGroundInbound string 1 Y/N eTail COD surface Inbound service
eTailCODGroundOutbound string 1 Y/N eTail COD surface Outbound service
eTailPrePaidAirInbound string 1 Y/N eTail Prepaid Apex Inbound Service
eTailPrePaidAirOutound string 1 Y/N eTail Prepaid Apex Outbound Service
eTailPrePaidGroundInbound string 1 Y/N eTail Prepaid surface Inbound service
eTailPrePaidGroundOutbound string 1 Y/N eTail Prepaid surface Outbound service
ApexEconomyInbound string 1 Y/N Apex Economy Inbound service
ApexEconomyOutbound string 1 Y/N Apex Economy Outbound service
DomesticPriorityTDD string 5 10:30 DP TDD (Time Definite delivery)
ApexTDD string 5 12:30 Apex TDD (Time Definite delivery)
Embargo string 1 Y/N Embargo Service
ErrorMessage string 500 If any error , error message details
IsError Boolean 5 True/False If error then true , else false
AirValueLimit double 10,2 9999999.99 Declared value limit
GroundValueLimit double 10,2 9999999.99 Declared value limit
DPDutsValueLimit double 10,2 9999999.99 Declared value limit
BlueDartHolidays List <Holiday> Holiday Object

10 | P a g e
Developers Guide for Integrating BLUE DART API 2018

eTailExpressCODAirInbound string 1 Y/N eTail Express COD Apex Inbound Service

eTailExpressCODAirOutbound string 1 Y/N eTail Express COD Apex Outbound Service

eTailExpressPrePaidAirInbound string 1 Y/N eTail Express Prepaid Apex Inbound Service

eTailExpressPrePaidAirOutound string 1 Y/N eTailExpressPrepaid Apex Outbound Service

RVPService string 9 Full RVP, RVP embargo service
Open RVP,
Close RVP
ApexEDLDist String 10 0-9 Apex EDL Distance
GroundEDLDist String 10 0-9 Surface EDL Distance
ApexEDLAddDays String 10 0-9 Apex EDL days
GroundEDLAddDays String 10 0-9 Surface EDL days
DPTDD10Inbound String 1 Y/N DP TDD 10 Inbound service
DPTDD10Outbound String 1 Y/N DP TDD 10 Outbound service
DPTDD12Inbound String 1 Y/N DP TDD 12 Inbound service
DPTDD12Outbound String 1 Y/N DP TDD 12 Outbound service
ApexETailTDD10Inbound String 1 Y/N Etail Apex TDD 10 Inbound service
ApexETailTDD10Outbound String 1 Y/N Etail Apex TDD 10 Outbound service
ApexETailTDD12Inbound String 1 Y/N Etail Apex TDD 12 Inbound service
ApexETailTDD12Outbound String 1 Y/N Etail Apex TDD 12 Outbound service
ApexEtailRVP string 9 Full RVP, Apex RVP service
Open RVP,
Close RVP
DartPlusRVP string 9 Full RVP, DP RVP service
Open RVP,
Close RVP
GroundRVP string 9 Full RVP, Surface RVP service
Open RVP,
Close RVP

Holiday Object

Parameters Data Length Allowed Description

Name Type Values
Description String 30 a-z,A-Z,0-9 Holiday Description
HolidayDate DateTime Blue Dart Holiday dates
GetServicesforProduct

This method will return service availablity for requested pincode,product / subproduct.

Request

Parameters Name Data Require Length Allowed Description

Type Values
pinCode string Y 6 0-9 Pin code
pProductCode string Y 1 A-Z Product code
pSubProductCode string Y 1 A-Z Sub product code
Profile Object Y Client details, profile details are given in
common objects sheet.

11 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Response :

Parameters Name Data Type Description

PinCodeServiceDetailsReference Object Return service detail object for a pin
code,product /sub product

PinCodeServiceDetailsReference Definition

Field Name Data Type Length Allowed Description

Values
AreaCode string 3 A-Z Area Code
ServiceCenterCode string 3 A-Z Service centre code
PinCode string 6 0-9 Pin Code
PinDescription string 25 a-z,A-Z,0-9 Pin code Description
Product string 1 A-Z Product code
SubProduct string 1 A-Z Sub product code
Service string 10 A-Z,/,& Service availability
ServiceName string 25 A-Z Product Description
IsError Boolean 5 True/false Error
ErrorMessage string 500 Error Message

GetServicesforPincodeAndProduct

This method will return service availablity for requested pincode,product / subproduct.

Request

Parameters Name Data Require Length Allowed Description

Type Values
pinCode string Y 6 0-9 Pin code
ProductCode string Y 1 A-Z Product code
SubProductCode string Y 1 A-Z Sub product code
PackType string Y 1 A-Z Packaging type refer master
Feature string Y 1 “R” For Reverse Logistic “R”
Profile Object Y Client details, profile details are given in
common objects sheet.

Response :

Parameters Name Data Type Description

PinCodeServiceDetailsReference Object Return service detail object for a pin
code,product /sub product

PinCodeServiceLocationDetailsReference Definition

Field Name Data Type Length Allowed Description

12 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Values
PincodeAreaCode string 3 A-Z Area Code
PincodeServiceCenterCode string 3 A-Z Service centre code
PickupAreaCode string 3 A-Z Pickup Area Code
PickupServiceCenterCode string 3 A-Z Pickup Service centre code
PickupService string 10 A-Z,/,& Service availability
DeliveryAreaCode string 3 A-Z Delivery Area Code
DeliveryServiceCenterCode string 3 A-Z Delivery Service centre code
DeliveryService string 10 A-Z,/,& Service availability
PinCode string 6 0-9 Pin Code
PinDescription string 25 a-z,A-Z,0-9 Pin code Description
Product string 1 A-Z Product code
SubProduct string 1 A-Z Sub product code
PackType string 1 A-Z Pack type
Feature string 1 A-Z “R” for Reverse logistics
ServiceName string 25 A-Z Product Description
IsError Boolean 5 True/false Error
ErrorMessage string 500 Error Message

Transit Time
The Transit Time Finder provides you with the delivery date for a selected service.
You are required to provide the Blue Dart service required by you, the Origin pin code, Destination
pin code ,pickup date and time .

WSDL : https://netconnect.bluedart.com/Ver1.9/ShippingAPI/Finder/ServiceFinderQuery.svc?wsdl

Methods used in Transit Time Finder

Sr Method Name Return Type Input Values

No
1 GetDomesticTransitTimeForPi DateTime pPinCodeFrom,
nCodeandProduct pPinCodeTo,
pProductCode,
pSubProductCode
pPudate,
pPickupTime,
profile

Detailed Description of each methods used in Transit Time Finder

13 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Method : GetDomesticTransitTimeForPinCodeandProduct:

This method will return Expected delivery date of the shipment when it is shipped on a certain date
for a selected service.

Request

Parameters Name Data Type Requi Length Allowed Description

re Values
pPinCodeFrom string Y 6 0-9 Origin Pin code
pPinCodeTo string Y 6 0-9
pProductCode string Y 1 A-Z
pSubProductCode string 1 0-9,A-Z
pPudate Date Y 8 Date
pPickupTime string Y 4 0-9 24 hrs format (e.g. 13:00)
profile Object Y Client details, profile details are
given in common objects sheet.

response

Parameters Name Data Description

Type
DomesticTranistTimeReference Object Return Transit time details

DomesticTranistTimeReference Definition:

Field Name Data Length Allowed Defau Description

Type Values lt
value
Area String 3 A-Z Delivery Area Code
ServiceCenter String 3 A-Z Delivery Service centre code
ExpectedDateDelivery Date 10 DD-MON-YY Expected delivery date
ExpectedDatePOD Date 10 DD-MON-YY Expected pod date, for non comp
AdditionalDays String 2 0-9 Additional days for EDL
ApexAdditionalDays String 2 0-9 Apex Additional days for EDL
GroundAdditionalDays String 2 0-9 Surface Additional days for EDL
EDLMessage String 1 Y/N EDL Product Serviceability
IsError Boolean 5 True/false false Error
ErrorMessage String 500 Error Message

Pickup
Pickup Registration
The Pickup registration API exposes methods those will be used to register a PIckup.

Service information:

14 | P a g e
Developers Guide for Integrating BLUE DART API 2018

WSDL :
https://netconnect.bluedart.com/Ver1.9/ShippingAPI/Pickup/PickupRegistrationService.svc?wsdl

Methods used in Pickup Registration

SR Method Name Return Type Input Values

No
1 RegisterPickup PickupRegistrationResponse PickupRegistrationRequest,
UserProfile Object
2 GetAllProductsAndSubProducts GetAllProductsAndSubProductsResponse UserProfile Object

Detailed Description of each methods used in Pickup Registration

Method : RegisterPickup:

This method will register Pickup using all necessary data as input parameters.

Request

Parameters Name Data Type Require Description

Request PickupRegistrationRequest Y Request Object containing all information
required to register a Pickup
Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

PickupRegistrationRequest Definition:

Field Name Data Type Require Length Allowed Values Description

ProductCode string Y 1 a-z, A-Z Product Code
AreaCode string Y 3 A-Z Area code of pin code
CustomerCode string Y 6 A-Z,0-9 Customer Code
CustomerName string Y 30 a-z,A-Z,0- Customer Name
9,./?;:'~!\\@\"#$
%^&*()[]+=_ /-
CustomerAddress1 string N 30 a-z,A-Z,0- Pickup Address1
9,./?;:'~!\\@\"#$
%^&*()[]+=_ /-
CustomerAddress2 string N 30 a-z,A-Z,0- Pickup Address2
9,./?;:'~!\\@\"#$
%^&*()[]+=_ /-
CustomerAddress3 string N 30 a-z,A-Z,0- Pickup Address3
9,./?;:'~!\\@\"#$
%^&*()[]+=_ /-
ContactPersonName string N 30 a-z,A-Z,0- Contact Person Name

15 | P a g e
Developers Guide for Integrating BLUE DART API 2018

9,./?;:'~!\\@\"#$
%^&*()[]+=_ /-
CustomerPincode string Y 6 0-9 Pickup Pincode
CustomerTelephoneN string N 6-15 0-9 Customer Telephone Number
umber
MobileTelNo string N 6-15 0-9 Contact Person Mobile Number
ShipmentPickupDate Date Y Shipment Pickup Date
ShipmentPickupTime string Y 5 0-9,: Shipment Pickup Time [00:00]
Remarks string N 60 a-z,A-Z,0- Special Instruction / Remarks
9,./?;:'~!\\@\"#$
%^&*()[]+=_ /-
NumberofPieces int N 4 0-9999 Number of Pieces in shipment
[Default value : 1]
WeightofShipment double N 8.2 0-99999999.99 Actual Weight of Shipment
VolumeWeight double N 8.2 0-99999999.99 Volumetric Weight of Shipment
RouteCode string N 2 a-z,A-Z,0-9 Pickup Route Code
[Default Value : 99]
OfficeCloseTime string Y 5 0-9,: Office close time of
customer[00:00]
EmailID string N 30 Standard emailid Customer EmailID
format
isToPayShipper bool N 1 Y/N ToPay Shipper or not
Default Value : false
DoxNDox string N 1 1/2 Dox or NDox
SubProducts String[] N 5 List Of SubProducts
ReferenceNo string N a-z, A-Z, 0-9 Reference No
AWBNo String[] N 12 0-9 Waybill Number , single waybill
number need to be passed , rest all
waybill numbers are ignored if you
pass more than 1
IsReversePickup bool N 1 True/false If reverse pickup then true , else
false
IsForcePickup bool N True,false True for register pickup
PackType String N 1 a-z, A-Z Packaging type
IsDDN bool N 1 True/false If Dedicated Delivery Network
then true, else false

Response :

Parameters Name Data Type Description

PickupRegistrationResponse Object Returns response object including status of
operation

PickupRegistrationResponse Definition:

Field Name Data Type Length Allowed Description

Values
TokenNumber string 6 0-9 Pickup registration Token Number
Status Array of object of type Pickup registration status List

16 | P a g e
Developers Guide for Integrating BLUE DART API 2018

ResponseStatus
IsError bool True/false Whether operation causes error or not

PickupRegistrationResponse Definition:

Field Name Data Type Description

PickupRegistrationStatus Enumerator Pickup registration status code

ErrorMessage string Descriptive error message if there is any error / Failure

Cancel Pickup Registration

Service information:

WSDL :
https://netconnect.bluedart.com/Ver1.9/ShippingAPI/Pickup/PickupRegistrationService.svc?wsdl

Method : CancelPickup

This method will allow user to cancel pickup (which are registered by him).

Request

Parameters Name Data Type Require Description

Request CancelPickupRequest Y Request object
Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

CancelPickupRequest Definition:

Field Name Data Type Require Length Allowed Values Description

Token No int Y 8 0 - 99999999 Pickup Token No

PickupRegistrationDate DateTime Y Pickup Registration Date
Remarks string N 60 a-z,A-Z,0- Cancel Pickup Remarks
9,./?;:'~!\\@\"#$%
^&*()[]+=_ /-

17 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Response :

Parameters Name Data Type Description

CancelPickupResponseEntity Object Returns response object including operation
status & Exception list.

CancelPickupResponseEntity Definition:

Field Name Data Type Allowed Description

Values
status Array of object Array of all status list
'CancelPickupResponseStatus'
IsError bool True/false Whether method returns error or not
CancelPickupResponseStatus Definition:

Field Name Data Type Description

StatusCode string Response Status code

StatusDescription string Response status description

Method : GetAllProductsAndSubProducts:

This method will return all product & subproduct codes details that will be used to send as input
parameters in Pickup Registration method.

Request

Parameters Name Data Type Require Description

Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

Response :

Parameters Name Data Type Description

GetAllProductsAndSubProductsRespons Object Returns all valid Product Codes & Sub Product
eEntity Codes

GetAllProductsAndSubProductsResponseEntity Definition:

Field Name Data Type Allowed Description

Values
ProductList Array of object 'Product' 0-9 Array of all valid Products used along with
their respective subproducts
IsError bool True/false Whether method returns error or not
ErrorMessage string Error Description (if any)

18 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Product Definition:

Field Name Data Type Description

ProductName string Name of Product

ProductDescription string Descriptive error message if there is any error / Failure
SubProducts Array Of string List of respective sub products

19 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Waybill Generation

This API exposes methods those will be used to generate new Waybill.

Service information:

WSDL : https://netconnect.bluedart.com/Ver1.9/ShippingAPI/WayBill/WayBillGeneration.svc?wsdl

Methods used in Waybill Generation

SR Method Name Return Type Input Values

No
1 GenerateWayBill WayBillGenerationResponse WayBillGenerationRequest,
UserProfile Object
2 ImportData List<WayBillGenerationResponse> List<WayBillGenerationRequest>
, UserProfile Object
3 CancelWaybill AWBCancelationResponse AWBCancelationRequest ,
UserProfile Object
4 UpdateEwayBill EwayBillResponse EwayBillRequest,
UserProfile Object

Detailed Description of each methods used in Waybill Generation

Method : GenerateWayBill:(Single Waybill Generation)

This method will generate Waybill using all necessary data as input parameters.

Request

Parameters Name Data Type Require Description

Request WayBillGenerationRequest Y Request Object containing all information
required to generate Waybill
Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

WayBillGenerationRequest Definition:
Field Name Data Type Require Description

Shipper Shipper Object Y Shipper Details

Consignee Consignee Object Y Consignee Details
Services Services Object Y Services Details i.e Product, Sub Product, Amt
Returnadds Returnadds Object N Return Address details.

20 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Shipper Definition:
Field Name Data Require Length Allowed Values Description
Type
OriginArea string Y 3 A-Z Customer Area code
CustomerCode string Y 6 A-Z,0-9 Customer Code
CustomerName string Y 30 a-z,A-Z,0- Customer Name. Mandatory
9,./?;:'~!\\@\"#$%^& for Intl Outbound product
*()[]+=_ /-
CustomerAddress1 string Y 30 a-z,A-Z,0- Customer Address1.
9,./?;:'~!\\@\"#$%^& Mandatory for Intl
*()[]+=_ /- Outbound product
CustomerAddress2 string N 30 a-z,A-Z,0- Customer Address2.
9,./?;:'~!\\@\"#$%^& Mandatory for Intl
*()[]+=_ /- Outbound product
CustomerAddress3 string N 30 a-z,A-Z,0- Customer Address3.
9,./?;:'~!\\@\"#$%^& Optional for Intl Outbound
*()[]+=_ /- product
CustomerPincode string Y 6 0-9 Customer Pincode
CustomerTelephone string N 6-15 0-9 Customer Telephone
Number
CustomerMobile string N 10-15 0-9 Customer Mobile Number.
Mandatory for Intl
Outbound product
CustomerEmailID string N 30 Standard emailid Customer EmailID.
format Mandatory for Intl
Outbound product
Sender string N 20 a-z,A-Z,0- Sender Name
9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
isToPayCustomer bool Y True/false To be used when mutually
agreed for shipment
carriage from any place
other than place of contract
signup.
Default Value : false
VendorCode string N 9 A-Z,0-9 Vendor Code
CustomerLatitude String N 20 0-9 Latitude
CustomerLongitude String N 20 0-9 Longitude

CustomerAddressinfo String N 50 a-z,A-Z,0- Address info

9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
CustomerGSTNumber String N 15 a-z,A-Z,0-9 Customer GST number
CustomerMaskedConta String N 50 a-z,A-Z,0-9 To be used, when Shipper
ctNumber does not want to share
consignee contact number &
allow calling through their

21 | P a g e
Developers Guide for Integrating BLUE DART API 2018

IVR, which can dial

consignee after decoding
the value provided in this
field
Customer Masked Contact
number
CustomerFiscalIDType string N 2 0-9 Customer Fiscal
Identification Type. Optional
for Intl Ecommerce product
CustomerFiscalID string N 50 0-9 Customer Fiscal
Identification Number.
Optional for Intl Ecommerce
product
CustomerRegistrationN Int N 35 0-9 Customer Registration
umber Number. Optional for Intl
Outbound product
CustomerRegistrationN string N 3 SDT=IOSS (Import Customer Registration
umberTypeCode One-Stop-Shop), Number Type Code.
SDT=LVG (Overseas Optional for Intl Outbound
Registered Supplier), product
SDT=VOEC (VAT on E-
Commerce),
VAT=VAT/GST (VAT
Registration),
FTZ=FTZ (Free Trade
Zone ID),
DAN=DAN (Deferment
Account Duties Only),
TAN=TAN (Deferment
Account Tax Only),
DTF=DTF (Deferment
Account Duties, Taxes
and Fees Only)
CustomerRegistrationN string N 2 Refer list of DHL Customer Registration
umberIssuerCountryCo Country/Region code Number Issuer Country
de below Code. Optional for Intl
Outbound product
CustomerBusinessParty string N 2 BU – Business Customer Business Party
TypeCode DC - Direct Consumer Type Code. Optional for Intl
GV – Government Outbound product
OT – Other
PR – Private
RE – Reseller

Consignee Definition:
Field Name Data Require Lengt Allowed Values Description
Type h
ConsigneeName String Y 30 a-z,A-Z,0- ConsigneeName.
9,./?;:'~!\\@\"#$%^&*()[]+ Mandatory for Intl
=_ /- Outbound product
ConsigneeAddress1 String Y 30 a-z,A-Z,0- ConsigneeAddress1.

22 | P a g e
Developers Guide for Integrating BLUE DART API 2018

9,./?;:'~!\\@\"#$%^&*()[]+ Mandatory for Intl

=_ /- Outbound product
ConsigneeAddress2 String N 30 a-z,A-Z,0- ConsigneeAddress2.
9,./?;:'~!\\@\"#$%^&*()[]+ Mandatory for Intl
=_ /- Outbound product
ConsigneeAddress3 String N 30 a-z,A-Z,0- ConsigneeAddress3.
9,./?;:'~!\\@\"#$%^&*()[]+ Optional for Intl
=_ /- Outbound product
ConsigneePincode String Y 6 0-9 Consignee Pincode.
Optional for Intl
Outbound product
ConsigneeTelephone String N 6-15 0-9 Consignee Telephone
Number
ConsigneeMobile String N 10-15 0-9 Consignee Mobile
Number. Mandatory
for Intl Outbound
product
ConsigneeAttention String N 30 a-z,A-Z,0- Attention Details of
9,./?;:'~!\\@\"#$%^&*()[]+ consignee
=_ /-
ConsigneeEmailID String N 50 Standard emailid format Customer Email ID is
Mandatory for Intl
Outbound product
ConsigneeLatitude String N 20 0-9 Latitude

ConsigneeLongitude String N 20 0-9 Longitude

ConsigneeAddressinfo String N 50 a-z,A-Z,0- Address info

9,./?;:'~!\\@\"#$%^&*()[]+
=_ /-
ConsigneeCountryCode String N 2 A-Z For US & Australia
Country Code is
Mandatory for product
code "I" and Sub
product code as 'P'.
Mandatory for Intl
Outbound product
ConsigneeStateCode String N 20 A-Z For US & Australia,
State code is
Mandatory for product
code "I" and Sub
product code as 'P'
ConsigneeCityName String N 20 A-Z City name is mandatory
for product code "I".
Mandatory for Intl
Outbound product
ConsigneeGSTNumber String N 15 a-z,A-Z,0-9 GST number
ConsigneeMaskedConta String N 50 Consignee Masked
ctNumber Contact number
ConsigneeAddressType String N 1 O, R, S, M “O” Office address , “R”
Residencial address ,

23 | P a g e
Developers Guide for Integrating BLUE DART API 2018

“S” Shop, “M” Mall

Delivery
AvailableTiming String N 30 0 -9, (- or ,) 0800-0900 ,1800-2000
Or 0930 – 1700
AvailableDays String N 7 1-7 [1234567] [ 1 begin
Monday and so on..
ConsigneeIDType String N 2 0-9 Consignee
Identification Type.
Optional for Intl
Ecommerce product
ConsigneeID String N 30 0-9 Consignee
Identification Number.
Optional for Intl
Ecommerce product
ConsigneeFiscalIDType String N 2 0-9 Consignee Fiscal
Identification Type.
Optional for Intl
Ecommerce product
ConsigneeFiscalID String N 50 0-9 Consignee Fiscal
Identification Type.
Optional for Intl
Ecommerce product
ConsingeeFederalTaxId Int N 20 0-9 Consingee Federal Tax
Id. Mandatory only for
Brazil Intl Outbound
product
ConsingeeStateTaxId Int N 20 0-9 Consingee StateTax Id.
Mandatory only for
Brazil Intl Outbound
product
ConsingeeRegistrationN Int N 35 0-9 Consingee Registration
umber Number. Mandatory
only for Intl Outbound
product for Eurpean
Union Countries (refer
List of Eurpean Union
Countries below).
ConsingeeRegistrationN String N 3 SDT=IOSS (Import One- Consingee Registration
umberTypeCode Stop-Shop), Number Type Code.
SDT=LVG (Overseas Mandatory only for Intl
Registered Supplier), Outbound product for
SDT=VOEC (VAT on E- Eurpean Union
Commerce), Countries (refer List of
VAT=VAT/GST (VAT Eurpean Union
Registration), Countries below).
FTZ=FTZ (Free Trade Zone
ID),
DAN=DAN (Deferment
Account Duties Only),
TAN=TAN (Deferment
Account Tax Only),

24 | P a g e
Developers Guide for Integrating BLUE DART API 2018

DTF=DTF (Deferment
Account Duties, Taxes and
Fees Only)
ConsingeeRegistrationN String N 2 Refer list of DHL Consingee Registration
umberIssuerCountryCo Country/Region code below Number Issuer Country
de Code. Mandatory only
for Intl Outbound
product for Eurpean
Union Countries (refer
List of Eurpean Union
Countries below).
ConsigneeBusinessPart String N 2 BU – Business Consignee Business
yTypeCode DC - Direct Consumer Party Type Code.
GV – Government Mandatory for Intl
OT – Other Outbound product
PR – Private
RE – Reseller

Returnadds Definition:
Field Name Data Type Require Length Allowed Values Description

ReturnAddress1 String Y 30 a-z,A-Z,0- Return Address1

9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
ReturnAddress2 String N 30 a-z,A-Z,0- Return Address2
9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
ReturnAddress3 String N 25 a-z,A-Z,0- Return Address3
9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
ReturnPincode String Y 6 0-9 Return Pincode
ReturnTelephone String N 6-15 0-9 Return Telephone Number
ReturnMobile String N 10-15 0-9 Return Mobile Number
ReturnEmailID String N 30 Standard emailid Return EmailID
format
ReturnContact String N 20 a-z,A-Z,0- Contact Person Name
9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
ManifestNumber String N A-Z,0-9 Manifest Number
ReturnLatitude String N 20 0-9 Latitude

ReturnLongitude String N 20 0-9 Longitude

ReturnAddressinfo String N 50 a-z,A-Z,0- Address info

9,./?;:'~!\\@\"#$%^&
*()[]+=_ /-
ReturnMaskedConta String N 50 Return Masked Contact
ctNumber number
To be used, when Shipper
does not want to share
consignee contact number &

25 | P a g e
Developers Guide for Integrating BLUE DART API 2018

allow calling through their

IVR, which can dial
consignee after decoding
the value provided in this
field

Services Definition:
Field Name Data Type Requir Length Allowed Description
e Values
ProductCode String Y 1 A-Z Product Code
ProductType ProductTyp Y ProductType. Product Type [Docs/Dutiables]
e Docs,
[Enumerat ProductType.
or] Dutiables
SubProductCode String N 1 A-Z C – COD i.e. Cash on Delivery
P – Prepaid
D - DOD i.e. Demand Draft on
Delivery,
A - FOD i.e. Freight on Delivery,
B - DOD FOD
PieceCount Int Y 1 0-9999 Number of pieces. Mandatory for
Intl Outbound product
ActualWeight Double Y 8,2 0- Shipment Actual Weight
99999999.99 [ if its Beyond 2.5 kg, then
dimension mandatory for product
"I"]. Mandatory for Intl Outbound
product
PackType String N 1 A-Z,0-9 Pack Type
Mandatory for Intl
Ecommerce/Cross Border CSB IV
product ,
Check packtype Master (available at
end of document) for more details
InvoiceNo String N 10 A-Z,0-9 Invoice Number
SpecialInstruction String N 50 a-z,A-Z,0- Special Instruction
9,./?;:'~!\\@\
"#$%^&*()[]+
=_ /-
DeclaredValue double N 10,2 0- Declared Value [Dutiable
9999999999. shipments]
99 Values in Rupees(INR).
Mandatory for Intl Outbound
product
CollactableAmount double N 10,2 0- Collactable Amount [Mandatory
9999999999. for COD] Values in Rupees(INR)
99
CreditReferenceNo String Y 20 A-Z,0-9 Credit Reference Number (Should
be unique)
Dimensions List of N List of dimension of multiple
Dimension Pieces

26 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Object
PickupDate DateTime Y Pickup Date
PickupTime Pickup Y 4 0-9 Pickup Time [0000]
Time
Commodity Object N Commodity Details in object
Commodity
Detail
PDFOutputNotRequire Bool N True,false PDF is generated by default . When
d PDF file is not required as part of
response pass the value as true
AWBNo String N 12 0-9 Waybill Number
RegisterPickup Bool N True,false Register pickup if waybill is sucessful
.Default false
DeliveryTimeSlot String N 10 Preferred delivery time slot
IsReversePickup Bool N True,false True for RVP shipment else false
IsForcePickup Bool N True,false True for register pickup
ParcelShopCode String N 10 A-Z,0-9 Parcel Shop Code
ForwardAWBNo String N 20 A-Z,0-9 Forward Waybill no in case of
reverse Shipment
ForwardLogisticComp String N 30 A-Z,0-9 For reverse shipment ,Logistic
Name Company name who has delivered
forward waybill
CreditReferenceNo2 String N 20 A-Z,0-9 Credit Reference Number 2
CreditReferenceNo3 String N 20 A-Z,0-9 Credit Reference Number 3
PickupMode String N 1 P or C P - Shipment to be Picked
Up.(Default)
C - Consignee will drop off the
shipment at BD location
Default null would be treated as
Picked Up

PickupType String N 15 A-Z,0-9  Additional feature code O Open

Quality Check
 Additional feature code T
Slotted Return
 Multiple value can be capture
base above p/u type like ('OS'
stands for Open as well as
exchange p/u)

ItemCount Int N 3 0-9 Number of Items

Mandatory when PickupType='O'
and
for Intl Ecommerce/Cross
Border/Cross Border CSB IV product
IsPartialPickup Bool N 1 True,false Partial Pickup true or false
TotalCashPaytoCusto Double N 12,2 0-9 Total Cash to be paid to consumer
mer

PreferredPickupTimeS String N 11 A-Z,0-9 Preferred Pickup Time Slot

lot ( Mandatory when PickupType='T')

27 | P a g e
Developers Guide for Integrating BLUE DART API 2018

DeferredDeliveryDays Int DeferredDeliveryDays

Officecutofftime String Officecutofftime
ItemDtl List of Item N List of Item of multiple
Object Item Counts ( Mandatory only when
PickupType='O')
PDFPrintContent Array Of N To be used, when mutually agreed
byte to deliver a shipment after printing
the contents in this field.
There is no physical pickup.
Eg : Tickets, Coupons

Data content in bytes will be

converted in PDF, printed &
delivered.

CustomerEDD Date N 8 Date Customer Promised delivery date

IsDDN Bool N 1 True,false Dedicated Delivery Network

ExchangeWaybillNo String N 12 0-9 Exchange Waybill No for Exchange
product
ItemImg List of N List of Item images in relation to the
ItemImg Items mentioned in ItemCount
Object
OTPBasedDelivery OTPBasedD N OTPBasedDeli OTPBasedDelivery
elivery very [LastMileFixedOTPAutoGenerate(OT
[Enumerat .LastMileFixe P generated by Blue Dart on
or] dOTPAutoGe Manifest receipt) /
nerate, LastMileFixedOTPpredefined(OTP
OTPBasedDeli generated by Shipper and validated
very by Blue dart on delivery)/
.LastMileFixe LastMileDynamicOTP(OTP
dOTPpredefin generated by Blue Dart at the time
ed, of delivery)/
OTPBasedDeli Default(Proceed with Delivery
very. without OTP check)]
LastMileDyna
micOTP,
OTPBasedDeli
very.Default
OTPCode String N 6 0-9 OTP Number mandate, when value
passed is
LastMileFixedOTPpredefined
in OTPBasedDelivery
Total_IGST_Paid Double N 8,2 0- Total_IGST_Paid is not mandate for
9999999999. Intl when there is a
99 Bond/undertaking
SupplyOfIGST String N Yes/No/NA SupplyOf IGST is mandatory for Intl
Outbound product
SupplyOfwoIGST String N Yes/No/NA SupplyOf without IGST is
mandatory for Intl Outbound
product

28 | P a g e
Developers Guide for Integrating BLUE DART API 2018

IncotermCode String N 5 A-Z Incoterm code(refer incoterm

master below)
IsChequeDD String N 1 Q/D Q - Cheque,
D - DD
is mandatory for DOD / DOD-FOD
shipments.
InsurancePaidBy String N 1 O/C Insurance arrangement
O - Owner ,
C - Carrier
FavouringName String N 50 A-Z,0-9 In whose name DD/CHQ is required
to be prepared.
is mandatory for DOD /DOD-FOD
shipments.
PayableAt String N 20 A-Z,0-9 Location of customer, Name of City,
Payable across the country.
is mandatory for DOD /DOD-FOD
shipments.
PreferredDeliveryDate DateTime N 8 DATE Customer Preffered delivery date if
any
DynamicQCDetails List of N Array of Dynamic QC details
DynamicQC
Details
IsIntlEcomCSBUser Bool N 4 True If product is CSB V Intl Outbound
then value should be true else don’t
pass anything
ExportImportCode String N 10 0-9 ExportImportCode is mandatory for
Intl Outbound product
TermsOfTrade String N 3 FOB, DTP, TermsOfTrade to be Brought in is
DAP mandatory for Intl Outbound
product
IsEcomUser String N 1 1/0 IsEcomUser is mandatory for Intl
Outbound product
1 – Yes
0 – No
InsuranceAmount Double N 12,2 0- Amount of insurance
99999999999
9.99
AuthorizedDealerCod String N 14 a-z,A-Z,0-9 Authorized Dealer Code is
e mandatory for Intl Outbound
product
CurrencyCode String N 3 A-Z Currency Code is optional for Intl
Outbound product(refer Currency
code master below)
OrderURL String N 255 a-z,A-Z,0- URL of the shipment order or where
9,./;: order reference can be looked
\\@\#$%^&* online. Optional for Intl Ecommerce
()[]+=_ /- product
EsellerPlatformName String N 80 a-z,A-Z,0- Main website/Domain name where
9,./;: the shipement order was sold on.
\\@\#$%^&* Optional for Intl Ecommerce
()[]+=_ /- product

29 | P a g e
Developers Guide for Integrating BLUE DART API 2018

BillingReference1 String N 80 a-z,A-Z,0-9 Reference should be populated with

orderID. Optional for Intl
Ecommerce product
BillingReference2 String N 80 a-z,A-Z,0-9 Reference should be populated with
merchant reference. Optional for
Intl Ecommerce product
MarketplaceName String N 50 a-z,A-Z,0- Main website name where the
9,./;: shipement order was sold on.
\\@\#$%^&* Optional for Intl Ecommerce
()[]+=_ /- product
MarketplaceURL String N 255 a-z,A-Z,0- Order URL of specific commodity.
9,./;: Optional for Intl Ecommerce
\\@\#$%^&* product
()[]+=_ /-
BillToCompanyName String N 60 a-z,A-Z Bill To Company Name. Mandatory
if Customer and bill to is different
for Intl Outbound product
BillToContactName String N 35 a-z,A-Z Bill To Contact Name. Mandatory if
Customer and bill to is different for
Intl Outbound product
BillToAddressLine1 String N 45 a-z,A-Z Bill To Address. Mandatory if
Customer and bill to is different for
Intl Outbound product
BillToCity String N 35 a-z,A-Z Bill To City. Mandatory if Customer
and bill to is different for Intl
Outbound product
BillToPostcode String N 15 a-z,A-Z,0-9 Bill To Post code. Mandatory if
Customer and bill to is different for
Intl Outbound product
BillToSuburb String N 35 a-z,A-Z Bill To Suburb. Mandatory if
Customer and bill to is different for
Intl Outbound product
BillToState String N 35 a-z,A-Z Bill To State. Mandatory if Customer
and bill to is different for Intl
Outbound product
BillToCountryName String N 30 Refer list of Bill To Country Name. Mandatory if
DHL Customer and bill to is different for
Country/Regi Intl Outbound product
on code
below
BillToCountryCode String N 2 Refer list of Bill To Country Code. Mandatory if
DHL Customer and bill to is different for
Country/Regi Intl Outbound product
on code
below
BillToPhoneNumber Int N 25 0-9 Bill To Phone Number. Mandatory if
Customer and bill to is different for
Intl Outbound product
BillToFederalTaxID String N 20 a-z,A-Z Bill To Federal Tax ID. Mandatory if
Customer and bill to is different only
for Brazil Intl Outbound product

30 | P a g e
Developers Guide for Integrating BLUE DART API 2018

ExporterCompanyNa String N 60 a-z,A-Z Name of company/business.

me Mandatory for Intl Outbound
product
ExporterSuiteDepartm String N 35 a-z,A-Z Suite or department name.
entName Mandatory for Intl Outbound
product
ExporterAddressLine1 String N 45 a-z,A-Z,0- Exporter Address1. Mandatory for
9,./?;:'~!\\@\ Intl Outbound product
"#$%^&*()[]+
=_ /-
ExporterAddressLine2 String N 45 a-z,A-Z,0- Exporter Address2. Mandatory for
9,./?;:'~!\\@\ Intl Outbound product
"#$%^&*()[]+
=_ /-
ExporterAddressLine3 String N 45 a-z,A-Z,0- Exporter Address3. Mandatory for
9,./?;:'~!\\@\ Intl Outbound product
"#$%^&*()[]+
=_ /-
ExporterCity String N 35 a-z,A-Z Exporter City Name. Mandatory for
Intl Outbound product
ExporterDivision String N 35 a-z,A-Z Exporter Division Name. Mandatory
for Intl Outbound product
ExporterDivisionCode String N 2 a-z,A-Z Exporter Division / State /
Prefecture / Province code.
Mandatory for Intl Outbound
product
ExporterPostalCode Int N 15 0-9 Exporter Zip / Postal Code.
Mandatory for Intl Outbound
product
ExporterCountryCode String N 2 Refer list of Exporter Country Code. Mandatory
DHL for Intl Outbound product
Country/Regi
on code
below
ExporterCountryName String N 30 Refer list of Exporter Country Name. Mandatory
DHL for Intl Outbound product
Country/Regi
on code
below
ExporterPersonName String N 35 a-z,A-Z Exporter Name. Mandatory for Intl
Outbound product
ExporterPhoneNumbe Int N 25 0-9 Exporter telephone number.
r Mandatory for Intl Outbound
product
Exporter_FaxNumber String N 25 a-z,A-Z,0-9 Exporter fax number. Optional for
Intl Outbound product
ExporterEmail String N 50 Standard Exporter Email ID. Mandatory for
email id Intl Outbound product
format
ExporterMobilePhone Int N 25 0-9 Exporter Mobile Number. Optional
Number for Intl Outbound product

31 | P a g e
Developers Guide for Integrating BLUE DART API 2018

ExporterRegistrationN Int N 35 0-9 Exporter Registration Number.

umber Mandatory for Intl Outbound
product
ExporterRegistrationN String N 3 SDT=IOSS Exporter Registration Number Type
umberTypeCode (Import One- Code. Mandatory for Intl Outbound
Stop-Shop), product
SDT=LVG
(Overseas
Registered
Supplier),
SDT=VOEC
(VAT on E-
Commerce),
VAT=VAT/GS
T (VAT
Registration),
FTZ=FTZ (Free
Trade Zone
ID),
DAN=DAN
(Deferment
Account
Duties Only),
TAN=TAN
(Deferment
Account Tax
Only),
DTF=DTF
(Deferment
Account
Duties, Taxes
and Fees
Only)
ExporterRegistrationN String N 2 Refer list of Exporter Registration Number
umberIssuerCountryC DHL Country Code. Mandatory for Intl
ode Country/Regi Outbound product
on code
below
ExporterBusinessParty String N 2 BU – Business Exporter Business Party Type Code.
TypeCode DC - Direct Mandatory for Intl Outbound
Consumer product
GV –
Government
OT – Other
PR – Private
RE – Reseller
SignatureName String N 35 a-z,A-Z Name of signatory. Optional for Intl
Outbound product

SignatureTitle String N 35 a-z,A-Z Title of signatory. Optional for Intl

Outbound product

32 | P a g e
Developers Guide for Integrating BLUE DART API 2018

ECCN String N 30 a-z,A-Z,0-9 Export Control Classification

Number. Optional for Intl Outbound
product
LicenseNumber String N 16 a-z,A-Z,0-9 The license number. Mandatory
only for Intl Outbound product for
Eurpean Union Countries only (refer
List of Eurpean Union Countries
below).

ExpiryDate DateTime N Expiry Date. Mandatory only for Intl

Outbound product for Eurpean
Union Countries only (refer List of
Eurpean Union Countries below).

ManufactureCountryC String N 2 A-Z Manufacture Country / Region

ode Code. Mandatory only for Intl
Outbound product

FreightCharge Double N 8,2 0- FRT Charges of the shipment.

99999999.99 Optional for Intl Outbound product

InsurenceCharge Double N 8,2 0- Insurance Charges of the shipment.

99999999.99 Optional for Intl Outbound product

CessCharge Double N 8,2 0- CESS Charges of the shipment.

99999999.99 Optional for Intl Outbound product
ReverseCharge Double N 8,2 0- Reverse Charges of the shipment.
99999999.99 Optional for Intl Outbound product
PayerGSTVAT Int N 20 0-9 Payer GST VAT. Optional for Intl
Outbound product
Additional Declaration String N 700 a-z,A-Z Additional Declaration. Optional for
Intl Outbound product
NotificationMessage String N 250 a-z,A-Z Optional for Intl Outbound product

Dimension Definition:
Field Name Data Require Length Allowed Description
Type Values
Length Double Y 6,2 Length. Mandatory for Intl Outbound
product
Breadth Double Y 6,2 Breadth Mandatory for Intl Outbound
product
Height Double Y 6,2 Height. Mandatory for Intl Outbound
product
Count Int Y 0-9 Piece Count for respective
dimension entry

Commodity Detail Definition:

Field Name Data Require Length Allowed Values Description

33 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Type
CommodityDetail1 String N 30 a-z,A-Z,0-9 Commodity Detail1
CommodityDetail2 String N 30 a-z,A-Z,0-9 Commodity Detail2
CommodityDetail3 String N 30 a-z,A-Z,0-9 Commodity Detail3

ItemDtl Definition:
Field Name Data Require Length Allowed Values Description
Type
ItemID string N 15 a-z,A-Z,0-9  Item ID
 For Intl outbound CSB V
product value should be
numeric and length
should be 10
 Sr. Number of the Line
Items of Invoice for
product

ItemName string Y 30 a-z,A-Z,0-9  Item name, like Phone, T-

Shirt, Sofa etc. (
Mandatory only when
PickupType='O')
 Mandatory for Intl
Ecommerce/Cross
Border/ Cross Border CSB
IV product/ Intl
outbound product
 Description of the Line
Items of Invoice for CSB V
product
ProductDesc1 String N 30 a-z,A-Z,0-9  Brand name like
Samsung, Reebok etc.
 Mandatory for Intl
Ecommerce/Cross
Border/ Cross Border CSB
IV product
 Mandatory For Intl
outbound product/ Intl
Ecommerce /Cross Border
CSBV
refer product description
master
 Commodity Type for CSB
V product
ProductDesc2 String N 30 a-z,A-Z,0-9 Product description like Size 8,
Note 2, black etc
SubProduct1 String N 30 a-z,A-Z,0-9 Sub product 1 with product
SubProduct2 String N 30 a-z,A-Z,0-9 Sub product 2 with product
SubProduct3 String N 30 a-z,A-Z,0-9 Sub product 3 with product
SubProduct4 String N 30 a-z,A-Z,0-9 Sub product 4 with product
ReturnReason String N 30 a-z,A-Z,0-9 Reason for return
Instruction String N 30 a-z,A-Z,0-9 Instruction 1 (IMEI number,
Tags intact etc)
ItemValue double Y 12,2 0-9  Value of the Product(
Mandatory only when
PickupType='O')

34 | P a g e
Developers Guide for Integrating BLUE DART API 2018

 Mandatory for Intl

Ecommerce/Cross
Border/ Cross Border CSB
IV and V/ Intl Outbound
product
 FOB Value for CSB V
product
SKUNumber String N 20 a-z,A-Z,0-9  SKU# or Marketplace
Item Code of shipment
content ,

 Mandatory for Intl

Ecommerce/Cross
Border/ Cross Border CSB
IV product
Itemquantity Int N 4 0-9  Mandatory for Intl
Ecommerce/Cross
Border/ Cross Border CSB
IV and V/ Intl Outbound
product
countryOfOrigin String N 2 a-z,A-Z,0-9 Manufactured country code
of shipment content
HSCode String N 20 a-z,A-Z,0-9 HS code for commercial
clearance. Mandatory for
Parcel International Direct
shipments going to US,
Mandatory for Intl Outbound
product value should be
numeric and max ength
should be 8
TaxableAmount Double N 10,2 0-9 Taxable amount.
Mandatory for Intl
Outbound product
CGSTAmount Double N 10,2 0-9 CGST
SGSTAmount Double N 10,2 0-9 SGST
IGSTAmount Double N 10,2 0-9 IGST
TotalValue Double N 10,2 0-9 Total Value
PlaceofSupply String N 15 a-z,A-Z Place of supply
InvoiceNumber String N 20 a-z,A-Z,0-9 Invoice Number
InvoiceDate Date N 8 Date Invoice Date
SellerName String N 20 a-z,A-Z Seller name
SellerGSTNNumber String N 15 a-z,A-Z,0-9 GST no of seller
cessAmount Double N 10,2 0-9 Cess Amount. Mandatory
for Intl Outbound product
eWaybillNumber Int N 12 0-9 EWayBill number is
mandatory for / Intl
Ecommerce/Cross Border
CSBV product.
eWaybillDate Date N 8 Date EWaybill generated date is
mandatory for / Intl
Ecommerce/Cross Border
CSBV product.
supplyType String N 1 a-z,A-Z,0-9 Supply Type

35 | P a g e
Developers Guide for Integrating BLUE DART API 2018

subSupplyType Int N 2 0-9 Sub Supply Type

docType String N 3 a-z,A-Z,0-9 Doc Type
IsMEISS String N 1 1/0 The Merchandise Export
from India Scheme (MEIS
Scheme) is a newly
launched scheme launched
as a part of the new
Foreign Trade Policy In
India which is mandatory
for Intl Outbound / Intl
Ecommerce/Cross Border
CSBV product.
1 – Yes
0 – No
PerUnitRate Double N 10,2 0 – 9999999999.99 Per Unit Rate is mandatory
for Intl Outbound product.
PieceID String N 4 0-9 Box number.
PieceID is mandatory for
Intl Outbound product.
Unit String N 3 A-Z Unit of Measurement (refer
Unit master below).
Unit is mandatory for Intl
Outbound product.
IGSTRate Double N 5,2 0-99999.99 IGST rate is mandatory if
IGST is applicable for CSBV
Intl Ecommerce/Cross
Border
Discount Double N 10,2 0 – 9999999999.99 Discount. Optional for Intl
Outbound product.
Weight Double N 4,2 0-9999.99 Weight per Item.
Mandatory for Intl
Outbound product.

ItemImage Definition:
Field Name Data Type Require Length Allowed Values Description

AWBNo String N 12 0-9 Waybill number

ItemID String N 15 a-z,A-Z,0-9 Item ID
ImageURL String N 200 a-z,A-Z,0-9,@,.,/ Image URL for RVP

DynamicQCDetails
Field Name Data Type Require Length Allowed Values Description

ItemID String N 15 0-9 Item Id of item details

QuestionId String N 50 0-9,A-z,A-Z Quality Check Question Id
Should be unique for Item
Max 10 question per Item
allowed
QuestionDescripti String N 100 a-z,A-Z,0-9,@,.,/ Quality check question

36 | P a g e
Developers Guide for Integrating BLUE DART API 2018

on
QuestionValue String N 30 a-z,A-Z,0-9,@,.,/ Dynamic question values
like Brand Name,Color of
product , etc
ExpectedAnswers String N 1 Y/N Expected answer of the
question
IsQCMandate Bool N 5 True/false Default true , when passed
as false then QC check is
overridden

WayBillGenerationResponse Definition:
Field Name Data Type Description

Status ArrayOf List of Response Status

WaybillGenerationstatus
object
IsError Bool Operation status : Success / Failure [true/false]
AWBNo String Waybill number
AWBPrintContent Array Of byte Contain waybill Print content in bytes which can be
converted in only PDF file.
DestinationArea String Destination area
DestinationLocation String Destination service centre
CCRCRDREF String Credit Reference number passed while request.
TokenNumber String Pickup registration Token Number
ShipmentPickupDate DateTime Shipment pickup date of Token number
IsErrorInPU Bool Pickup Operation status : Success / Failure
[true/false]

Waybillgenerationstatus Definition:
Field Name Data Type Description

StatusCode String Response status code for Waybill generation

StatusInformation String Descriptive status message [error / Info]

Method : ImportData:(Multiple Waybill Generation )

This method will generate Waybill using all necessary data as input parameters.

Request

Parameters Name Data Type Require Description

Request List<WayBillGeneration Y Request Object containing all information
Request> required to generate Waybill
Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

37 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Response

Parameters Name Data Type Require Description

Response List<WayBillGeneration Y Response Object
Response>

For multiple WayBillGenerationRequest & WayBillGenerationResponse Definition is same

as of single waybill generation

Detailed Description of Update EwayBill

Method : UpdateEwayBill

Provision to update Ewaybill number generated by customer against blue dart waybill numbers.

Request

Parameters Name Data Type Require Description

Request EwayBillRequest Y Request Object containing all information
required to Update EWaybill
Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

Response

Parameters Name Data Type Require Description

Response EwayBillResponse Y Response Object containing all information
After Cancel Waybill

EwayBillRequest Definition :

Field Name Data Type Require Length Allowed Values Description

Waybillnumber string Y 12 0-9 Blue Dart Airway bill Number

SellerGSTNo string Y 15 a-z,A-Z,0-9 GST no of seller
eWaybillNumber Int Y 12 0-9 EwayBill Number
eWaybillDate Date Y 8 Date EwayBill Generated Date
InvoiceNumber string Y 20 a-z,A-Z,0-9 Invoice Number
InvoiceDate Date Y 8 Date Invoice Generated Date

EwayBillResponse Definition :

Field Name Data Type Description

Status ArrayOf List of Response Status

WaybillGenerationstatus
object
IsError bool Operation status : Success / Failure [true/false]

38 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Detailed Description of WayBill Cancelation

Method: CancelWaybill

This method will cancel Waybill request before Shipment Manifest (In-scan).

Request

Parameters Name Data Type Require Description

Request AWBCancelationRequest Y Request Object containing all information
required to Cancel Waybill
Profile UserProfile Y Client details, UserProfile details are given
in common objects sheet as P_ClientObject.

Response

Parameters Name Data Type Require Description

Response AWBCancelationResponse Y Response Object containing all information
After Cancel Waybill

AWBCancelationRequest Definition :

Field Name Data Type Require Length Allowed Values Description

AWBNo string Y 12 0-9 Blue Dart Airway bill Number

AWBCancelationRequest Definition:

Field Name Data Type Description

Status ArrayOf List of Response Status

WaybillGenerationstatus
object
IsError bool Operation status : Success / Failure [true/false]
AWBNo string Waybill number

ALTInstruction Update

This method is used to update Alternate instructions for a Waybill number. Few Alternate
instructions are RTO a shipment, Reattempt for delivery etc.

Service information:

WSDL: https://netconnect.bluedart.com/Ver1.9/ShippingAPI/ALTInstruction/
ALTInstructionUpdate.svc?wsdl

39 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Methods used in alt Instruction

SR Method Name Return Type Input Values

No
1 CustALTInstructio ALTInstructionResponse ALTInstructionRequest,
nUpdate UserProfile Object

Request

Parameters Name Data Type Require Description

Request ALTInstructionRequest Y Request Object containing all information
required to ALTInsruction
Profile UserProfile Y Client details, UserProfile details are given in
common objects sheet as P_ClientObject.

Response

Parameters Name Data Type Require Description

Response ALTInstructionResponse Y Response Object containing all information
After Cancel Waybill

ALTInstructionRequest Definition:

Field Name Data Type Require Length Allowed Values Description

AWBNo string Y 12 0-9 Blue Dart Airway bill Number

PreferDate DateTime N DateTimeFormat Reattempt date [ mandate for
[IST] DT]
AltInstRequestT string Y 8 RTO/DT/ED/LM/ RTO = Cancel Waybill/RTO
ype AM DT = Reattempt Delivery
ED = Escalation Delivery
LM = Land Mark Change
AM = Alternate Mobile#
TimeSlot string N 1 A/B/C/D Bluedart delivery time slot
MobileNo string N 10 0-9 Customer mobile number
[Mandate for AM]
PreferTime string N 4 0-9 Customer requested time slot for
delivery
LandMark String N 30 a-z,A-Z,0- Alternate Land mark change. [
9,./?;:'~!\\@\"#$ mandate for LM]
%^&*()[]+=_ /-

ALTInstructionResponse Definition:

40 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Field Name Data Type Description

Status ArrayOf List of Response Status

CustALTInstrucStatus
object
IsError bool Operation status : Success / Failure [true/false]
AWBNo string Waybill number

Sample SOAP UI rest Call

URL for demo:
http://netconnect.bluedart.com/Ver1.9/Demo/ShippingAPI/ALTInstruction/ALTInstructionUpdate.sv
c/rest/CustALTInstructionUpdate

Method = Post

Sample Request Data for RTO:

{
"altreq": {
"AWBNo": "69501388751",
"PreferDate": "/Date(1517893738847)/",
"AltInstRequestType": "RTO",
"TimeSlot": "",
"MobileNo": "",
"PreferTime":""
},
"profile": {
"LoginID": "Valid Login ID",
"LicenceKey": "Valid Key",
"Api_type": "S",
"Version": "1.9"
}
}

Sample Response of RTO :

<Response
xmlns="http://netconnect.bluedart.com/Ver1.9/Demo/ShippingAPI/ALTInstruction/ALTInstructionU
pdate.svc/rest/CustALTInstructionUpdate">
<CustALTInstructionUpdateResult>
<AWBNo>69501388751</AWBNo>
<IsError>false</IsError>
<status>
<e>
<StatusCode>Valid</StatusCode>
<StatusInformation>Waybill Number : 69501388751 Is Canceled
Successfully.</StatusInformation>
</e>
</status>
</CustALTInstructionUpdateResult>

41 | P a g e
Developers Guide for Integrating BLUE DART API 2018

</Response>

Sample Request Data for DT (Reattempt):

{
"altreq": {
"AWBNo": "59500670843",
"PreferDate": "/Date(1537168283019)/",
"AltInstRequestType": "DT",
"TimeSlot": "",
"MobileNo": "",
"PreferTime":""
},
"profile": {
"LoginID": "Valid Login ID",
"LicenceKey": "Valid Key",
"Api_type": "S",
"Version": "1.9"
}
}
Sample Response of DT :

<Response
xmlns="http://netconnect.bluedart.com/Ver1.9/Demo/ShippingAPI/ALTInstruction/ALTInstructionU
pdate.svc/rest/CustALTInstructionUpdate">
<CustALTInstructionUpdateResult>
<AWBNo>59500670843</AWBNo>
<IsError>false</IsError>
<status>
<e>
<StatusCode>Valid</StatusCode>
<StatusInformation>AltInstrucation Update Successful</StatusInformation>
</e>
</status>
</CustALTInstructionUpdateResult>
</Response>

Master Download
This API exposes methods those will be used for masters download.

Service information:

WSDL :
https://netconnect.bluedart.com/Ver1.9/ShippingAPI/Master/MasterDownloadQuery.svc?wsdl

Methods used in Master download

42 | P a g e
Developers Guide for Integrating BLUE DART API 2018

SR Method Name Return Type Input Values

No
1 DownloadPinCo List<ServiceCenterDetailsRefere lastSynchDate,
deMaster nce> UserProfile Object

Detailed Description of each methods used in Master download

Method : DownloadPinCodeMaster

This method will downloads incremental pin code master changes .

Request

Parameters Name Data Require Length Allowed Description

Type Values
lastSynchDate DateTime Y 6 Valid Date Last synch date to be passed
profile Object Y Client details, profile details are given in
common objects sheet.

Response :

Parameters Name Data Type Description

List<ServiceCenterDetailsReference> Object Return service detail object for a pin code

ServiceCenterDetailsReference Definition:

Field Name Data Type Length Allowed Description

Values
PinCode string 6 0-9 Pin Code
PincodeDescription string 25 a-z,A-Z,0-9 Pin code location description
AreaCode string 3 A-Z Area code of pin code
ServiceCenterCode string 3 A-Z Service centre code of pin code
DomesticPriorityInbound string 1 Y/N Domestic Priority Inbound service
DomesticPriorityOutbound string 1 Y/N Domestic Priority Outbound Service
ApexInbound string 1 Y/N Dart Apex Inbound service
ApexOutbound string 1 Y/N Dart Apex outbound service
GroundInbound string 1 Y/N Surface Inbound service
GroundOutbound string 1 Y/N Surface Outbound Service
eTailCODAirInbound string 1 Y/N eTail COD Apex Inbound Service
eTailCODAirOutbound string 1 Y/N eTail COD Apex Outbound Service
eTailCODGroundInbound string 1 Y/N eTail COD surface Inbound service
eTailCODGroundOutbound string 1 Y/N eTail COD surface Outbound service
eTailPrePaidAirInbound string 1 Y/N eTail Prepaid Apex Inbound Service
eTailPrePaidAirOutound string 1 Y/N eTail Prepaid Apex Outbound Service
eTailPrePaidGroundInbound string 1 Y/N eTail Prepaid surface Inbound service
eTailPrePaidGroundOutbound string 1 Y/N eTail Prepaid surface Outbound service
DomesticPriorityTDD string 5 10:30 DP TDD (Time Definite delivery)
ApexTDD string 5 12:30 Apex TDD (Time Definite delivery)
ErrorMessage string 500 If any error , error message details
If no error , INSER/UPDATE/DELETE flag for
any change in service

43 | P a g e
Developers Guide for Integrating BLUE DART API 2018

IsError Boolean 5 True/False If error then true , else false

AirValueLimit double 10,2 9999999.99 Declared value limit
GroundValueLimit double 10,2 9999999.99 Declared value limit
BlueDartHolidays List <Holiday> Holiday Object
eTailExpressCODAirInbound string 1 Y/N eTail Express COD Apex Inbound Service
eTailExpressCODAirOutbound string 1 Y/N eTail Express COD Apex Outbound Service

eTailExpressPrePaidAirInbound string 1 Y/N eTail Express Prepaid Apex Inbound Service

eTailExpressPrePaidAirOutound string 1 Y/N eTailExpressPrepaid Apex Outbound Service

Holiday Object

Parameters Data Length Allowed Description

Name Type Values
Description string 30 a-z,A-Z,0-9 Holiday Description
HolidayDate DateTime Blue Dart Holiday dates

Common object
Objects which used in all methods is known as common objects

Common object details

Sr Object Name Description
No
1 Profile Client details (UserProfile)

User Profile
Field Name Data Require Length Allowed Default Description
Type Values value
LoginID string Y 30 A-Z,0-9 Login ID of client
LicenceKey string Y 2000 A-Z,0-9 Licence key
Api_type string N 1 T/S S Shipping API
Version string N 5 1.0 1.0 Shipping API version
Area string N 3 A-Z For Affiliates to login

Common Master Details

Country Master
Country Name Code

Australia AU

United States US

44 | P a g e
Developers Guide for Integrating BLUE DART API 2018

United Kingdom GB

State Master
US Australia
State State State code
State Code
Australian Capital Territory ACT
Alabama AL
Queensland QLD
Alaska AK
New South Wales NSW
American Samoa AS
Northern Territory NT
Arizona AZ
South Australia SA
Arkansas AR
Tasmania TAS
California CA
Victoria VIC
Colorado CO
Western Australia WA
Connecticut CT
Delaware DE
Dist. of Columbia DC
Florida FL
Georgia GA
Guam GU
Hawaii HI
Idaho ID
Illinois IL
Indiana IN
Iowa IA
Kansas KS
Kentucky KY
Louisiana LA
Maine ME
Maryland MD
Marshall Islands MH
Massachusetts MA
Michigan MI
Micronesia FM
Minnesota MN
Mississippi MS
Missouri MO
Montana MT
Nebraska NE
Nevada NV
New Hampshire NH
New Jersey NJ

45 | P a g e
Developers Guide for Integrating BLUE DART API 2018

New Mexico NM
New York NY
North Carolina NC
North Dakota ND
Northern Marianas MP
Ohio OH
Oklahoma OK
Oregon OR
Palau PW
Pennsylvania PA
Puerto Rico PR
Rhode Island RI
South Carolina SC
South Dakota SD
Tennessee TN
Texas TX
Utah UT
Vermont VT
Virginia VA
Virgin Islands VI
Washington WA
West Virginia WV
Wisconsin WI
Wyoming WY

46 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Products Master

Product and Sub product details for waybill generation

Sub Product
Product Product Description
D Domestic Priority
E Ground
A Air/Apex
A C eTailCODAir
E C eTailCODGround
A P eTailPrePaidAir
ETailPrePaidGroun
E P d
I P Intel E-comm.

Product and Sub product details for Pickup Registration

PRODUCT
CODE SUB PRODUCT CODE
A DART PLUS
A DC
A DOD
A EDL
A E-Tailing
A Express Pallete 100
A Express Pallete 50
A Express Pallete 75
A FOD
A FOV
A Smart Box 10
A Smart Box 25
A Smart Box Mult
A TDD
A Economy
D Critical Express
D TDD
E DOD
E EDL
E E-Tailing
E Express Pallete 100
E Express Pallete 50
E Express Pallete 75
E FOD
E FOV/DC
E Smart Box 10
E Smart Box 25
E Smart Box Mult
I DTP
I Express Easy 6
I Express Easy 8
I Express Pallete
I Imp/EXP
I SII

47 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Pack Type Master

(for Waybill generation)

PRODCOD SUBPRDC PACKTYP

E D E PACKDESC
A A Apex FOD
A B Apex DODFOD
A C L Dart Plus COD
A C N Ecom Cod TDD 12.00
A C P Ecom COD eShip
A C T Ecom Cod TDD 10.30
A C Apex COD
A D Apex DOD
A E Apex LITE
A P L Dart Plus Prepaid
A P N Ecom Prepaid TDD 12.00
A P P Ecom Prepaid eShip
A P T Ecom Prepaid TDD 10.30
A P Apex Prepaid
A Dart Apex
A T Apex TDD
D Domestic Priority
D T Domestic TDD 1030
D N Domestic TDD 1200
E A Express FOD
E B Express DODFOD
E C Express COD
E D Express DOD
E P Express Prepaid
E Dart SFC Line
I P D Parcel Intl Direct PLT
I P P GM Packet Plus Std PPS
I P S GM Packet Std PKD
I 1 Express Easy Box 6 (JJ)
I 2 Express Easy Box 8 (JB)
I 4 Express Easy Box 4
I 7 University Express
I C Express Pallete
I E Intl Others
I K INTL TDI 09:00 DOC -TDK
I O Intl. Others
I P Intl Others
I Q Temperature Controlled
I R Global Mail
I T INTL TDI 12:00 DOC -TDT
I Y INTL TDI 12:00 NONDOC-TDY

48 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Product Description Master for Intl Ecom CSB

Product Description

Handicraft Items/Products
Handloom Products
Books/Periodicals
Leather Footwear
Toys
Customized Fashion Garments
Others

Postal code format for Intel E-Comm.

Country Pattern
Australia (AU) NNNN
United Kingdom (GB) AN NAA
ANN NAA
ANA NAA
AAN NAA
AANN NAA
AANA NAA
United States (US) NNNNN
NNNNNNNNN
NNNNN-NNNN
NNNNNNNNNN
N

Incoterm code master

The Incoterms or International Commercial Terms are a series of pre-defined commercial terms published
by the International Chamber of Commerce (ICC) relating to international commercial law. They are widely
used in international commercial transactions or procurement processes and their use is encouraged by
trade councils, courts and international lawyers.[1] A series of three-letter trade terms related to common
contractual sales practices, the Incoterms rules are intended primarily to clearly communicate the tasks,
costs, and risks associated with the global or international transportation and delivery of goods. Incoterms
inform sales contracts defining respective obligations, costs, and risks involved in the delivery of goods
from the seller to the buyer, but they do not themselves conclude a contract, determine the price payable,
currency or credit terms, govern contract law or define where title to goods transfers.

The Incoterms rules are accepted by governments, legal authorities, and practitioners worldwide for the
interpretation of most commonly used terms in international trade. They are intended to reduce or remove
altogether uncertainties arising from differing interpretation of the rules in different countries. As such they
are regularly incorporated into sales contracts[2] worldwide.

"Incoterms" is a registered trademark of the ICC.

List of Incoterms frequently used

49 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Incoterm Code Code Description

CFR Cost and freight

CIF Cost, insurance, freight

CIP Carriage and insurance paid to

CPT Carriage paid to

DAF Delivered at frontier

DAP Delivered At Place

DAT Delivered At Terminal

DDP Delivered Duty Paid

DDU Delivered Duty unpaid

DEQ Delivered ex quay

DES Delivered ex ship

EXW Ex works

FAS Free alongside Ship

FCA Free Carrier

FOB Free on Board

Unit master

Unit Unit Description

BAG Bags

BAL Bale

BDL Bundles

BKL Buckles

BOU Billions of units

BOX Box

BTL Bottles

BUN Bunches

CAN Cans

50 | P a g e
Developers Guide for Integrating BLUE DART API 2018

CBM Cubic meters

CCM Cubic centimetres

CMS Centimetres

CTN Cartons

DOZ Dozens

DRM Drums

GGK Great gross

GMS Grammes

GRS Gross

GYD Gross yards

KGS Kilograms

KLR Kilolitre

KME Kilometre

MLT Millilitre

MTR Meters

MTS Metric ton

NOS Numbers

PAC Packs

PCS Pieces

PRS Pairs

QTL Quintal

ROL Rolls

SET Sets

SQF Square feet

SQM Square meters

SQY Square Yards

TBS Tablets

TGM Ten Gross

THD Thousands

TON Tonnes

51 | P a g e
Developers Guide for Integrating BLUE DART API 2018

TUB Tubes

UGS US Gallons

UNT Units

YDS Yards

Currency code master

Currency Code Currency Code Description

AED UAE Dirham

AUD Australian Dollar

BHD Bahrain Dinar

CAD Canadian Dollar

CHF Swiss Francs

DKK Danish Kroner

EUR Euro

GBP Pound Sterling

HKD Hong Kong Dollar

INR Indian Rupees

JPY Japanese Yen

KES Kenya Shilling

KRW Korean Won

KWD Kuwait Dinar

NOK Norwegian Kroner

NZD New Zealand Dollar

QAR Qatari Riyal

SAR Saudi Arabian Riyal

SEK Swedish Kroner

SGD Singapore Dollar

TRY Turkish Lira

USD U.S. Dollar

YEN Chinese Yuan

52 | P a g e
Developers Guide for Integrating BLUE DART API 2018

ZAR South African Rand

European Union Country master

Country Name Country Code

Austria AT

Belgium BE

Bulgaria BG

Croatia HR

Cyprus CY

CZECH REPUBLIC,
THE CZ

Denmark DK

Estonia EE

Finland FI

France FR

Germany DE

Greece GR

Hungary HU

IRELAND,
REPUBLIC OF IE

Italy IT

Latvia LV

Lithuania LT

Luxembourg LU

Malta MT

Netherlands NL

Poland PL

Portugal PT

53 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Romania RO

Slovakia SK

Slovenia SI

Spain ES

Sweden SE

DHL Country Region code master

Country / Region Postcode Format Significant Figures

Code Country / Region Name

AD ANDORRA 99999 5

AD ANDORRA AA999 5

AM ARMENIA 9999 4

AR ARGENTINA 9999 4

AS AMERICAN SAMOA 99999 5

AT AUSTRIA 9999 4

AU AUSTRALIA 9999 4

AZ AZERBAIJAN 9999 4

BA BOSNIA AND HERZEGOVINA 99999 5

BD BANGLADESH 9999 4

BE BELGIUM 9999 4

BG BULGARIA 9999 4

BN BRUNEI AA9999 6

BR BRAZIL 99999 5

BR BRAZIL 99999-999 5

BR BRAZIL 99999999 5

BY BELARUS 999999 6

CA CANADA A9A 9A 6

54 | P a g e
Developers Guide for Integrating BLUE DART API 2018

CA CANADA A9A 9A9 6

CH SWITZERLAND 9999 4

CN CHINA, PEOPLES REPUBLIC 999999 6

CO COLOMBIA 999999 6

CU CUBA 99999 5

CY CYPRUS 9999 4

CZ CZECH REPUBLIC, THE 999 99 6

DE GERMANY 99999 5

DK DENMARK 9999 4

DZ ALGERIA 99999 5

EC ECUADOR 999999 6

EE ESTONIA 99999 5

ES SPAIN 99999 5

FI FINLAND 99999 5

MICRONESIA, FEDERATED
FM STATES OF 99999 5

FO FAROE ISLANDS 999 3

FR FRANCE 99999 5

GB UNITED KINGDOM AA9A 9AA 6

GB UNITED KINGDOM A99 9AA 5

GB UNITED KINGDOM A9A 9AA 5

GB UNITED KINGDOM A9 9AA 4

GB UNITED KINGDOM AA99 9AA 6

GB UNITED KINGDOM AA9 9AA 5

GB UNITED KINGDOM AA9A 9 6

GE GEORGIA 9999 4

GF FRENCH GUYANA 99999 5

55 | P a g e
Developers Guide for Integrating BLUE DART API 2018

GG GUERNSEY AA99 9AA 4

GG GUERNSEY AA9 9AA 3

GL GREENLAND 9999 4

GP GUADELOUPE 99999 5

GR GREECE 999 99 6

GU GUAM 99999 5

GU GUAM 99999-9999 5

HR CROATIA 99999 5

HU HUNGARY 9999 4

IC CANARY ISLANDS, THE 99999 5

ID INDONESIA 99999 5

IL ISRAEL 9999999 7

IN INDIA 999999 6

IS ICELAND 999 3

IT ITALY 99999 5

JE JERSEY AA9 9AA 3

JP JAPAN 999-9999 8

KG KYRGYZSTAN 999999 6

KH CAMBODIA 99999 5

KOREA, REPUBLIC OF (SOUTH

KR K.) 99999 5

KV KOSOVO 99999 5

KZ KAZAKHSTAN 999999 6

LI LIECHTENSTEIN 9999 4

LT LITHUANIA 99999 5

LU LUXEMBOURG 9999 4

LV LATVIA 9999 4

56 | P a g e
Developers Guide for Integrating BLUE DART API 2018

MA MOROCCO 99999 5

MC MONACO 99999 5

MD MOLDOVA, REPUBLIC OF 9999 4

ME MONTENEGRO, REPUBLIC OF 99999 5

MG MADAGASCAR 999 3

MH MARSHALL ISLANDS 99999 5

MK MACEDONIA, REPUBLIC OF 9999 4

MN MONGOLIA 999999 6

MN MONGOLIA 99999 5

COMMONWEALTH NO.
MP MARIANA ISLANDS 99999 5

MQ MARTINIQUE 99999 5

MV MALDIVES 99999 5

MV MALDIVES 9999 4

MX MEXICO 99999 5

MY MALAYSIA 99999 5

NC NEW CALEDONIA 99999 5

NL NETHERLANDS, THE 9999 4

NL NETHERLANDS, THE 9999 AA 4

NO NORWAY 9999 4

NZ NEW ZEALAND 9999 4

PG PAPUA NEW GUINEA 999 3

PH PHILIPPINES, THE 9999 4

PK PAKISTAN 99999 5

PL POLAND 99-999 6

PR PUERTO RICO 99999 5

PT PORTUGAL 9999-999 8

57 | P a g e
Developers Guide for Integrating BLUE DART API 2018

PW PALAU 99999 5

RE REUNION, ISLAND OF 99999 5

RO ROMANIA 999999 6

RS SERBIA, REPUBLIC OF 99999 5

RU RUSSIAN FEDERATION, THE 999999 6

SE SWEDEN 999 99 6

SG SINGAPORE 999999 6

SH SAINT HELENA AAAA 9AA 8

SI SLOVENIA 9999 4

SK SLOVAKIA 999 99 6

SM SAN MARINO 99999 5

SZ SWAZILAND A999 4

TH THAILAND 99999 5

TN TUNISIA 9999 4

TR TURKEY 99999 5

TW TAIWAN 999 3

TW TAIWAN 99999 5

UA UKRAINE 99999 5

US UNITED STATES OF AMERICA 99999 5

US UNITED STATES OF AMERICA 99999-9999 5

UZ UZBEKISTAN 999999 6

VI VIRGIN ISLANDS (US) 99999 5

XY ST. BARTHELEMY 99999 5

YT MAYOTTE 99999 5

ZA SOUTH AFRICA 9999 4

CZ CZECH REPUBLIC, THE 999 99 6

58 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Shipping API Client Application

Prerequisites of using Shipping API demo client

 Dot Net framework 3.5
 ODBC Driver configuration for using Import Excel File.

Simple Coding Demo of Client Application in Visual Studio

Step 1: Open WPF application and right click on reference in the solution explorer .

Right click on reference and add

Service Reference

Enter the Service URL in

address bar and click on Go
b
Step 2: Service Reference window will be open after step 1 , enter below address in address bar
click on GO button : http://netconnect.bluedart.com/ShippingAPI/Finder/ServiceFinderQuery.svc

59 | P a g e
 Developers Guide for Integrating BLUE DART API 2018

Step 3: After entering Endpoint address , below screen will be displayed , it will display all methods
availabe in WSDL file.

Click to
existing methods in
view all
WSDL file
methods

Click on ok to finish
can change
add reference
Namespace

60 | P a g e
 Developers Guide for Integrating BLUE DART API 2018

Step 4: click on Service reference1 in solution explorer , object browser window will open ,

Namespace of the proxy Service reference is visible

connection in solution explorer

can view available class in

existing namespace

61 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Step5: Open calling form and write the code as given below.

62 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Excel File import

Note: If client machine is not installed with MS Office then please install AccessDatabaseEngine.exe
first

Step 1 : Create ODBC Driver for Excel Files ( If below highlighted entry is not there then click on Add
button to add the entry )
( ODBC is found in Control Panel--> Administrative Tools --> Data Source ODBC )

or

Run c:\Windows\SysWOW64\odbcad32.exe ( for windows 7)

Step 2: For configuring ODBC Driver , Click on Configure button

63 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Step 3 : Set Data Source Name

Data Source Name should be "Excel Files" only don't change this
Select excel file for import by Clicking on Select workbook . ( One time only)
Uncheck on Read only if any .

64 | P a g e
Developers Guide for Integrating BLUE DART API 2018

Common Terminology
Detailed description of common terminology used in this document

Sr No Common Terminology Description

1 Pin Code Indian postal code
2 Area Code 3 letter IATA code
3 ServiceCenterCode Blue dart's pickup and delivery location code
4 TDD Time Definite delivery
5 EDL Extra delivery location
6 POD Proof of Delivery
7 Pickup Date Date on which shipment is connected/manifested in Blue Dart network

Shipping API Demo URLs

Pin Code Finder
http://netconnect.bluedart.com/Ver1.9/Demo/ShippingAPI/Finder/ServiceFinderQuery.svc?wsdl

Transit Time
http://netconnect.bluedart.com/ Ver1.9/Demo/ShippingAPI/Finder/ServiceFinderQuery.svc?wsdl

Pickup Registration
https://netconnect.bluedart.com/ Ver1.9/ Demo/ShippingAPI/Pickup/PickupRegistrationService.svc?wsdl

Cancel Pickup Registration

https://netconnect.bluedart.com/ Ver1.9/Demo/ShippingAPI/Pickup/PickupRegistrationService.svc?wsdl

Waybill Generation
https://netconnect.bluedart.com/ Ver1.9/Demo/ShippingAPI/WayBill/WayBillGeneration.svc?wsdl

ALTInsruction Update
https://netconnect.bluedart.com/ Ver1.9/Demo/ShippingAPI/ ALTInstruction/
ALTInstructionUpdate.svc?wsdl

65 | P a g e