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
2017
2018
2019

Reverse Pickup Features

E-waybill Features

Alternate Instructions API

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”

Dotnet

https://netconnect.bluedart.com/samples/Dotnet/ShippingAPItestClientsetup.zip

https://netconnect.bluedart.com/samples/Dotnet/ShippingAPItestClientsetup_64bit.zip

Java

https://netconnect.bluedart.com/samples/Java/ShippingAPIJavaClientineclipse.zip

PHP

https://netconnect.bluedart.com/samples/Php/PHPservice.zip

Document

https://netconnect.bluedart.com/samples/Document/BlueDartAPIService.docx

SR No

Method Name 

Return Type

Input Values

1

GetServicesforPincode

ServiceCenterDetailsReference

pinCode,

profile

2

GetServicesforProduct

PinCodeServiceDetailsReference

pinCode,
pProductCode,
pSubProductCode
profile

3

GetServicesforPincodeAndProduct

PinCodeServiceLocationDetailsReference

pinCode,
ProductCode,
SubProductCode,

PackType,

Feature
profile

Parameters Name

Data Type

Require

Length

Allowed Values

Description

pinCode

String

Y

6

0-9

Pin code

Profile

Object

Y

Client details, profile details are given in common objects sheet.

Parameters Name

Data Type

Description

ServiceCenterDetailsReference 

Object

Return service detail object for a pin code

Field Name

Data Type

Length

Allowed Values

Description

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

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, Open RVP, Close RVP

RVP embargo service

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, Open RVP, Close RVP

Apex RVP service

DartPlusRVP

string

9

Full RVP, Open RVP, Close RVP

DP RVP service

GroundRVP

string

9

Full RVP, Open RVP, Close RVP

Surface RVP service

Parameters Name

Data Type

Length

Allowed Values

Description

Description

String

30

a-z,A-Z,0-9

 Holiday Description

HolidayDate

DateTime

 Blue Dart Holiday dates

Parameters Name

Data Type

Require

Length

Allowed Values

Description

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.

Parameters Name

Data Type

Description

PinCodeServiceDetailsReference

Object

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

Field Name

Data Type

Length

Allowed Values

Description

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

Parameters Name

Data Type

Require

Length

Allowed Values

Description

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.

Parameters Name

Data Type

Description

PinCodeServiceDetailsReference

Object

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

Field Name

Data Type

Length

Allowed Values

Description

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

Sr No

Method Name 

Return Type

Input Values

1

GetDomesticTransitTimeForPinCodeandProduct

DateTime

pPinCodeFrom,

pPinCodeTo,

pProductCode,

pSubProductCode pPudate,

pPickupTime,

profile

Parameters Name

Data Type

Require

Length

Allowed Values

Description

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.

Parameters Name

Data Type

Description

DomesticTranistTimeReference

Object

Return Transit time details

Field Name

Data Type

Length

Allowed Values

Default value

Description

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

SR No

Method Name 

Return Type

Input Values

1

RegisterPickup

PickupRegistrationResponse

PickupRegistrationRequest, UserProfile  Object

2

GetAllProductsAndSubProducts

GetAllProductsAndSubProductsResponse

UserProfile  Object

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.

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Customer Name

CustomerAddress1

string

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Pickup Address1

CustomerAddress2

string

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Pickup Address2

CustomerAddress3

string

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Pickup Address3

ContactPersonName

string

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Contact Person Name

CustomerPincode

string

Y

6

0-9

Pickup Pincode

CustomerTelephoneNumber

string

N

6-15

0-9

Customer Telephone Number

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Special Instruction / Remarks

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 format

Customer EmailID

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

Parameters Name

Data Type

Description

PickupRegistrationResponse

Object

Returns response object including status of operation

Field Name

Data Type

Length

Allowed Values

Description

TokenNumber

string

7

0-9

Pickup registration Token Number

Status

Array of object of type ResponseStatus

Pickup registration status List

IsError

bool

True/false

Whether operation causes error or not

Field Name

Data Type

Description

PickupRegistrationStatus

Enumerator

Pickup registration status code

ErrorMessage

string

Descriptive error message if there is any error / Failure

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.

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Cancel Pickup Remarks

Parameters Name

Data Type

Description

CancelPickupResponseEntity

Object

Returns response object including operation status & Exception list.

Field Name

Data Type

Allowed Values

Description

status

Array of object ‘CancelPickupResponseStatus’

Array of all status list

IsError

Bool

True/false

Whether method returns error or not

Field Name

Data Type

Description

StatusCode

string

Response Status code

StatusDescription

string

Response status description

Parameters Name

Data Type

Require

Description

Profile

UserProfile

Y

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

Parameters Name

Data Type

Description

GetAllProductsAndSubProductsResponseEntity

Object

Returns all valid Product Codes & Sub Product Codes

Field Name

Data Type

Allowed Values

Description

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)

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

SR No

Method Name 

Return Type

Input Values

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

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.

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.

Field Name

Data Type

Require

Length

Allowed Values

Description

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Customer Name. Mandatory for Intl Outbound product

CustomerAddress1

string

Y

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Customer Address1. Mandatory for Intl Outbound product

CustomerAddress2

string

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Customer Address2. Mandatory for Intl Outbound product

CustomerAddress3

string

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Customer Address3. 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 format

Customer EmailID. Mandatory for Intl Outbound product

Sender

string

N

20

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Sender Name

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Address info

CustomerGSTNumber

String

N

15

a-z,A-Z,0-9

Customer GST number

CustomerMaskedContactNumber

String

N

50

a-z,A-Z,0-9

To be used, when Shipper does not want to share consignee contact number & allow calling through their 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 and applicable only for Intl Ecommerce product

CustomerFiscalID

string

N

50

0-9

Customer Fiscal Identification Number. Optional and applicable only for Intl Ecommerce product.

For GB the Customer Fiscal ID should have GB+9 or GB+12 numeric digits and

For EU the Customer fiscal ID should have IM+10 numeric digits

CustomerRegistrationNumber

string

N

35

A-Z,a-z,0-9

Customer Registration Number. Optional for Intl Outbound Dutiable product.

If registration number is entered then CustomerRegistrationNumberTypeCode, CustomerRegistrationNumberIssuerCountryCode, CustomerBusinessPartyTypeCode fields need to be passed with proper combination (Refer RegistrationNumberType excel file)

CustomerRegistrationNumberTypeCode

string

N

3

Refer Registration Number Type from RegistrationNumberTypeCode excel sheet

Customer Registration Number Type Code. Optional for Intl Outbound Dutiable product

CustomerRegistrationNumberIssuerCountryCode

string

N

2

Refer Issuing Country from RegistrationNumberTypeCode excel sheet

Customer Registration Number Issuer Country Code. Optional for Intl Outbound Dutiable product

CustomerBusinessPartyTypeCode

string

N

2

BU – Business

DC – Direct Consumer

GV – Government

OT – Other

PR – Private

RE – Reseller

Customer Business Party Type Code. Optional for Intl Outbound Dutiable product

Field Name

Data Type

Require

Length

Allowed Values

Description

ConsigneeName

String

Y

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

ConsigneeName. Mandatory for Intl Outbound Dutiable product

ConsigneeAddress1

String

Y

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

ConsigneeAddress1. Mandatory for Intl Outbound Dutiable product

ConsigneeAddress2

String

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

ConsigneeAddress2. Mandatory for Intl Outbound Dutiable product

ConsigneeAddress3

String

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

ConsigneeAddress3. Optional for Intl Outbound Dutiable product

ConsigneePincode

String

Y

6

0-9

Consignee Pincode. Optional for Intl Outbound Dutiable 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 Dutiable product

ConsigneeAttention

String

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Attention Details of consignee

ConsigneeEmailID

String

N

50

Standard emailid format

Customer Email ID is

Mandatory for Intl Outbound Dutiable product

ConsigneeLatitude           

String

N

20

0-9

Latitude           

ConsigneeLongitude        

String

N

20

0-9

Longitude        

ConsigneeAddressinfo     

String

N

50

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Address info

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 Dutiable product

ConsigneeGSTNumber

String

N

15

a-z,A-Z,0-9

GST number

ConsigneeMaskedContactNumber

String

N

50

Consignee Masked Contact number

ConsigneeAddressType

String

N

1

O, R, S, M

“O” Office address , “R” Residencial address , “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 and applicable only for Intl Ecommerce product

ConsigneeID

String

N

30

0-9

Consignee Identification Number. Optional and applicable only for Intl Ecommerce product

ConsigneeFiscalIDType

String

N

2

0-9

Consignee Fiscal Identification Type. Optional and applicable only for Intl Ecommerce product

ConsigneeFiscalID

String

N

50

0-9

Consignee Fiscal Identification Type. Optional and applicable only for Intl Ecommerce product

ConsingeeFederalTaxId

String

N

20

0-9

Consingee Federal Tax Id. Mandatory only for Brazil Intl Outbound Dutiable product

ConsingeeStateTaxId

String

N

20

0-9

Consingee StateTax Id. Mandatory only for Brazil Intl Outbound Dutiable product

ConsingeeRegistrationNumber

String

N

35

0-9

Consingee Registration Number. Mandatory only for Intl Outbound Dutiable product for Eurpean Union Countries (refer List of Eurpean Union Countries below).

ConsingeeRegistrationNumberTypeCode

String

N

3

SDT=IOSS (Import One-Stop-Shop),

SDT=LVG (Overseas Registered Supplier),

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)

Consingee Registration Number Type Code. Mandatory only for Intl Outbound Dutiable product for Eurpean Union Countries (refer List of Eurpean Union Countries below).

ConsingeeRegistrationNumberIssuerCountryCode

String

N

2

Refer list of DHL Country/Region code below

Consingee Registration Number Issuer Country Code. Mandatory only for Intl Outbound Dutiable product for Eurpean Union Countries (refer List of Eurpean Union Countries below).

ConsigneeBusinessPartyTypeCode

String

N

2

BU – Business

DC – Direct Consumer

GV – Government

OT – Other

PR – Private

RE – Reseller

Consignee Business Party Type Code. Mandatory for Intl Outbound Dutiable product

Field Name

Data Type

Require

Length

Allowed Values

Description

ReturnAddress1

String

Y

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Return Address1

ReturnAddress2

String

N

30

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Return Address2

ReturnAddress3

String

N

25

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Return Address3

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 format

Return EmailID

ReturnContact

String

N

20

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Contact Person Name

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Address info

ReturnMaskedContactNumber

String

N

50

Return Masked Contact number
To be used, when Shipper does not want to share consignee contact number & allow calling through their IVR, which can dial consignee after decoding the value provided in this field

Field Name

Data Type

Require

Length

Allowed Values

Description

ProductCode

String

Y

1

A-Z

Product Code

ProductType

ProductType

[Enumerator]

Y

ProductType.Docs, ProductType.Dutiables

Product Type [Docs/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 Dutiable product

ActualWeight

Double

Y

8,2

0-99999999.99

Shipment Actual Weight
[ if its Beyond 2.5 kg, then dimension mandatory for product “I”]. Mandatory for Intl Outbound Dutiable 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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Special Instruction

DeclaredValue

Double

N

10,2

0-9999999999.99

Declared Value [Dutiable shipments]

Values in Rupees(INR).

Mandatory for Intl Outbound Dutiable product

CollactableAmount

Double

N

10,2

0-9999999999.99

Collactable Amount [Mandatory

for COD] Values in Rupees(INR)

CreditReferenceNo

String

Y

20

A-Z,0-9

Credit Reference Number (Should

be unique)

Dimensions

List of Dimension Object

N

List of dimension of multiple

Pieces

PickupDate

DateTime

Y

Pickup Date

PickupTime

Pickup Time

Y

4

0-9

Pickup Time [0000]

Commodity

Object CommodityDetail

N

Commodity Details in object

PDFOutputNotRequired

Bool

N

True,false

PDF is generated by default . When 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

ForwardLogisticCompName

String

N

30

A-Z,0-9

For reverse shipment ,Logistic 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

TotalCashPaytoCustomer

Double

N

12,2

0-9

Total Cash to be paid to consumer

PreferredPickupTimeSlot

String

N

11

A-Z,0-9

Preferred Pickup Time Slot
( Mandatory when PickupType=’T’)

DeferredDeliveryDays

Int

DeferredDeliveryDays

Officecutofftime

String

Officecutofftime

ItemDtl

List of Item Object

N

List of Item of multiple

Item Counts ( Mandatory only when PickupType=’O’)

PDFPrintContent

Array Of byte

N

To be used, when mutually agreed 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 ItemImg Object

N

List of Item images in relation to the Items mentioned in ItemCount

OTPBasedDelivery

OTPBasedDelivery

[Enumerator]

N

OTPBasedDelivery .LastMileFixedOTPAutoGenerate,

OTPBasedDelivery .LastMileFixedOTPpredefined,

OTPBasedDelivery.

LastMileDynamicOTP, OTPBasedDelivery.Default

OTPBasedDelivery [LastMileFixedOTPAutoGenerate(OTP generated by Blue Dart on Manifest receipt) / LastMileFixedOTPpredefined(OTP generated by Shipper and validated by Blue dart on delivery)/ LastMileDynamicOTP(OTP generated by Blue Dart at the time of delivery)/

Default(Proceed with Delivery without OTP check)]

OTPCode

String

N

6

0-9

OTP Number mandate, when value passed is LastMileFixedOTPpredefined
in OTPBasedDelivery

Total_IGST_Paid

Double

N

8,2

0-9999999999.99

Total_IGST_Paid is not mandate for Intl when there is a 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

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

PrinterLableSize

Enumerator

N

15

PrinterLableSize.LabelSizeA4S

/LabelSizeA4T

/LabelSize55X30

/LabelSize89X60

PrinterLableSize.LabelSizeA4S = A4 size single label [ current PDF]

PrinterLableSize.LabelSizeA4T = A4 size lable with 3 copy

PrinterLableSize.LabelSize55X30 = 55*30 label size

PrinterLableSize.LabelSize89X60 = 89*60 label size.

DynamicQCDetails

List of DynamicQCDetails

N

Array of Dynamic QC 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, DAP

TermsOfTrade to be Brought in is 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-999999999999.99

Amount of insurance

AuthorizedDealerCode

String

N

14

a-z,A-Z,0-9

Authorized Dealer Code is 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-9,./;: \\@\#$%^&*()[]+=_ /-

URL of the shipment order or where order reference can be looked online. Optional and applicable only for Intl Ecommerce product

EsellerPlatformName

String

N

80

a-z,A-Z,0-9,./;: \\@\#$%^&*()[]+=_ /-

Main website/Domain name where the shipement order was sold on. Optional and applicable only for Intl Ecommerce product

BillingReference1

String

N

80

a-z,A-Z,0-9

Reference should be populated with orderID. Optional and applicable only for Intl Ecommerce product

BillingReference2

String

N

80

a-z,A-Z,0-9

Reference should be populated with merchant reference. Optional and applicable only for Intl Ecommerce product

MarketplaceName

String

N

50

a-z,A-Z,0-9,./;: \\@\#$%^&*()[]+=_ /-

Main website name where the shipement order was sold on. Optional and applicable only for Intl Ecommerce product

MarketplaceURL

String

N

255

a-z,A-Z,0-9,./;: \\@\#$%^&*()[]+=_ /-

Order URL of specific commodity. Optional and applicable only 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 Dutiable product

BillToContactName

String

N

35

a-z,A-Z

Bill To Contact Name. Mandatory if Customer and bill to is different for Intl Outbound Dutiable product

BillToAddressLine1

String

N

45

a-z,A-Z

Bill To Address. Mandatory if Customer and bill to is different for Intl Outbound Dutiable product

BillToCity

String

N

35

a-z,A-Z

Bill To City. Mandatory if Customer and bill to is different for Intl Outbound Dutiable 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 Dutiable product

BillToSuburb

String

N

35

a-z,A-Z

Bill To Suburb. Mandatory if Customer and bill to is different for Intl Outbound Dutiable product

BillToState

String

N

35

a-z,A-Z

Bill To State. Mandatory if Customer and bill to is different for Intl Outbound Dutiable product

BillToCountryName

String

N

30

Refer list of DHL Country/Region code below

Bill To Country Name. Mandatory if Customer and bill to is different for Intl Outbound Dutiable product

BillToCountryCode

String

N

2

Refer list of DHL Country/Region code below

Bill To Country Code. Mandatory if Customer and bill to is different for Intl Outbound Dutiable product

BillToPhoneNumber

String

N

25

0-9

Bill To Phone Number. Mandatory if Customer and bill to is different for Intl Outbound Dutiable 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 Dutiable product

ExporterCompanyName

String

N

60

a-z,A-Z

Name of company/business. Mandatory for Intl Outbound Dutiable product

ExporterSuiteDepartmentName

String

N

35

a-z,A-Z

Suite or department name. Mandatory for Intl Outbound Dutiable product

ExporterAddressLine1

String

N

45

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Exporter Address1. Mandatory for Intl Outbound Dutiable product

ExporterAddressLine2

String

N

45

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Exporter Address2. Mandatory for Intl Outbound Dutiable product

ExporterAddressLine3

String

N

45

a-z,A-Z,0-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Exporter Address3. Mandatory for Intl Outbound Dutiable product

ExporterCity

String

N

35

a-z,A-Z

Exporter City Name. Mandatory for Intl Outbound Dutiable product

ExporterDivision

String

N

35

a-z,A-Z

Exporter Division Name. Mandatory for Intl Outbound Dutiable product

ExporterDivisionCode

String

N

2

a-z,A-Z

Exporter Division / State / Prefecture / Province code. Mandatory for Intl Outbound Dutiable product

ExporterPostalCode

String

N

15

0-9

Exporter Zip / Postal Code. Mandatory for Intl Outbound Dutiable product

ExporterCountryCode

String

N

2

Refer list of DHL Country/Region code below

Exporter Country Code. Mandatory for Intl Outbound Dutiable product

ExporterCountryName

String

N

30

Refer list of DHL Country/Region code below

Exporter Country Name. Mandatory for Intl Outbound Dutiable product

ExporterPersonName

String

N

35

a-z,A-Z

Exporter Name. Mandatory for Intl Outbound Dutiable product

ExporterPhoneNumber

String

N

25

0-9

Exporter telephone number. Mandatory for Intl Outbound Dutiable product

ExporterFaxNumber

String

N

25

a-z,A-Z,0-9

Exporter fax number. Optional for Intl Outbound Dutiable product

ExporterEmail

String

N

50

Standard email id format

Exporter Email ID. Mandatory for Intl Outbound Dutiable product

ExporterMobilePhoneNumber

String

N

25

0-9

Exporter Mobile Number. Optional for Intl Outbound Dutiable product

ExporterRegistrationNumber

String

N

35

0-9

Exporter Registration Number. Mandatory for Intl Outbound Dutiable product

ExporterRegistrationNumberTypeCode

String

N

3

SDT=IOSS (Import One-Stop-Shop),

SDT=LVG (Overseas Registered Supplier),

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)

Exporter Registration Number Type Code. Mandatory for Intl Outbound Dutiable product

ExporterRegistrationNumberIssuerCountryCode

String

N

2

Refer list of DHL Country/Region code below

Exporter Registration Number Country Code. Mandatory for Intl Outbound Dutiable product

ExporterBusinessPartyTypeCode

String

N

2

BU – Business

DC – Direct Consumer

GV – Government

OT – Other

PR – Private

RE – Reseller

Exporter Business Party Type Code. Mandatory for Intl Outbound Dutiable product

SignatureName

String

N

35

a-z,A-Z

Name of signatory. Optional for Intl Outbound Dutiable product

SignatureTitle

String

N

35

a-z,A-Z

Title of signatory. Optional for Intl Outbound Dutiable product

ECCN

String

N

30

a-z,A-Z,0-9

Export Control Classification Number. Optional for Intl Outbound Dutiable product

FreightCharge

Double

N

8,2

0-99999999.99

FRT Charges of the shipment. Optional for Intl Outbound Dutiable product

InsurenceCharge

Double

N

8,2

0-99999999.99

Insurance Charges of the shipment. Optional for Intl Outbound Dutiable product

CessCharge

Double

N

8,2

0-99999999.99

CESS Charges of the shipment. Optional for Intl Outbound Dutiable product

ReverseCharge

Double

N

8,2

0-99999999.99

Reverse Charges of the shipment. Optional for Intl Outbound Dutiable product

PayerGSTVAT

Double

N

8,2

0-99999999.99

Payer GST VAT. Optional for Intl Outbound Dutiable product

Additional Declaration

String

N

700

a-z,A-Z

Additional Declaration. Optional for Intl Outbound Dutiable product

NotificationMessage

String

N

250

a-z,A-Z

Optional for Intl Outbound Dutiable product

IsCargoShipment

Bool

N

5

TRUE/FALSE

If requested shipment is corgo then value should be TRUE else FALSE

ExportReason

String

N

20

A-Z,a-z

Mandatory for Intl Ecommerce value should be Bonafide Sample/ Sample/ Gift for CSB IV and Commercial for CSB V.

Optional for Intl Outbound value can be anything.

BankAccountNumber

String

N

40

0-9

Shipper Bank Account number which is registered in ICE Gate portal. BankAccountNumber is mandatory and applicable only for Intl Outbound CSBV product.

GovNongovType

String

N

1

G – Government

OR

P – Private

This is for the shipper to declare whether they are a Government or Non-Government Entity. GovNongovType is mandatory and applicable only for Intl Outbound CSBV product.

NFEIFlag

Bool

N

5

TRUE/FALSE

Shipper to declare whether there is a Payment to be received or not at shipment level. NFEIFlag is mandatory and applicable only for Intl Outbound CSBV product.

noOfDCGiven

Double

N

10,2

0-99999999.99

Number of delivery challan given

IsCommercialShipment

Bool

N

5

TRUE/FALSE

If requested shipment is Commercial then value should be TRUE else FALSE. This applicable only for Intl Dutiable product.

IsDutyTaxPaidByShipper

Bool

N

5

TRUE/FALSE

If duty tax is paid by shipper then value should be TRUE else FALSE. This applicable only for Intl Dutiable product.

Field Name

Data Type

Require

Length

Allowed Values

Description

Length

Double

Y

6,2

Length. Mandatory for Intl Outbound Dutiable product

Breadth

Double

Y

6,2

Breadth Mandatory for Intl Outbound Dutiable product

Height

Double

Y

6,2

Height. Mandatory for Intl Outbound Dutiable product

Count

Int

Y

0-9

Piece Count for respective

dimension entry

Field Name

Data Type

Require

Length

Allowed Values

Description

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

Field Name

Data Type

Require

Length

Allowed Values

Description

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’)

ü  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 Dutiable 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 Dutiable 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

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 Dutiable product.

Weight

Double

N

4,2

0-9999.99

Weight per Item. Mandatory for Intl Outbound Dutiable product.

CommodityCode

String

N

8

A-Z,a-z

Commodity Code, Mandatory for Intl Outbound product.

LicenseNumber

String

N

16

a-z,A-Z,0-9

The license number. Mandatory only for Intl Outbound Dutiable product for Eurpean Union Countries only (refer List of Eurpean Union Countries below).

LicenseExpiryDate

DateTime

N

Expiry Date. Mandatory only for Intl Outbound Dutiable product for Eurpean Union Countries only (refer List of Eurpean Union Countries below).

ManufactureCountryCode

String

N

2

A-Z

Manufacture Country / Region Code. Mandatory only for Intl Outbound Dutiable product

ManufactureCountryName

String

N

2

A-Z

Manufacture Country / Region Name. Mandatory only for Intl Outbound Dutiable product

PieceIGSTPercentage

Double

N

3,2

0-999.99

IGST Percentage based on IGST value. Mandatory only if IGST value passed for CSBV product

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

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

QuestionDescription

String

N

100

a-z,A-Z,0-9,@,.,/

Quality check question

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

Field Name

Data Type

Description

Status

ArrayOf WaybillGenerationstatus  object

List of Response Status

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]

TransactionAmount

Double

Amount deducted for booked shipment

AvailableAmountForBooking

Double

Balance amount excluding threshold amount to book next shipment

AvailableBalance

Double

Total available balance

Field Name

Data Type

Description

StatusCode

String

Response status code for Waybill generation

StatusInformation

String

Descriptive status message [error / Info]

Parameters Name

Data Type

Require

Description

Request

List<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.

Parameters Name

Data Type

Require

Description

Response

List<WayBillGenerationResponse>

Y

Response Object

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.

Parameters Name

Data Type

Require

Description

Response

EwayBillResponse

Y

Response Object containing all information After Cancel Waybill

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

Field Name

Data Type

Description

Status

ArrayOf WaybillGenerationstatus  object

List of Response Status

IsError

bool

Operation status : Success / Failure [true/false]

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.

Parameters Name

Data Type

Require

Description

Response

AWBCancelationResponse

Y

Response Object containing all information After Cancel Waybill

Field Name

Data Type

Require

Length

Allowed Values

Description

AWBNo

string

Y

12

0-9

Blue Dart Airway bill Number

Field Name

Data Type

Description

Status

ArrayOf WaybillGenerationstatus  object

List of Response Status

IsError

bool

Operation status : Success / Failure [true/false]

AWBNo

string

Waybill number

SR No

Method Name 

Return Type

Input Values

1

CustALTInstructionUpdate

ALTInstructionResponse

ALTInstructionRequest,
UserProfile  Object

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.

Parameters Name

Data Type

Require

Description

Response

ALTInstructionResponse

Y

Response Object containing all information After Cancel Waybill

Field Name

Data Type

Require

Length

Allowed Values

Description

AWBNo

string

Y

12

0-9

Blue Dart Airway bill Number

PreferDate

DateTime

N

DateTimeFormat [IST]

Reattempt date [ mandate for DT]

AltInstRequestType

string

Y

8

RTO/DT/ED/LM/AM

RTO = Cancel Waybill/RTO

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-9,./?;:’~!\\@\”#$%^&*()[]+=_ /-

Alternate Land mark change.  [ mandate for LM]

Field Name

Data Type

Description

Status

ArrayOf CustALTInstrucStatus object

List of Response Status

IsError

bool

Operation status : Success / Failure [true/false]

AWBNo

string

Waybill number

SR No

Method Name 

Return Type

Input Values

1

DownloadPinCodeMaster

List<ServiceCenterDetailsReference>

lastSynchDate,
UserProfile  Object

Parameters Name

Data Type

Require

Length

Allowed Values

Description

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.

Parameters Name

Data Type

Description

List<ServiceCenterDetailsReference> 

Object

Return service detail object for a pin code

Field Name

Data Type

Length

Allowed Values

Description

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

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

Parameters Name

Data Type

Length

Allowed Values

Description

Description

string

30

a-z,A-Z,0-9

 Holiday Description

HolidayDate

DateTime

 Blue Dart Holiday dates

Sr No

Object Name

Description

1

Profile

Client details (UserProfile)

Field Name

Data Type

Require

Length

Allowed Values

Default value

Description

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