Blue Dart-Pickup Cancellation
v 0.1
Division: DHL eCommerce

Best for:

The Cancel Pickup registration API exposes methods which will be used to cancel a Pickup. This Service provide the flexibility to registered customer to cancel its Shipment pickup

Cancel Pickup Registration :

This service will allow customer or user to cancel a pickup for its shipment. Canceling of pickup will be applicable to customer who are registered for the shipment order to Pickup.

The customer will use detail along with additional information related to shipment as token number and pickup registration date for its shipment order.

Region: India
Overview

About Blue Dart

Blue Dart Express Ltd., South Asia's premier express air, integrated transportation & distribution company, offers secure and reliable delivery of consignments to over 55,400+ locations in India. Blue Dart is a provider of choice for its stakeholders due to its customer centric approach and aims to further strengthen this partnership. As part of Deutsche Post DHL Group's DHL eCommerce Solutions division, Blue Dart accesses the largest and most comprehensive express and logistics network worldwide, covering over 220 countries and territories, and offers an entire spectrum of distribution services including air express, freight forwarding, supply chain solutions, customs clearance etc.

The Blue Dart team drives market leadership through its motivated people, dedicated air and ground capacity, cutting-edge technology, wide range of innovative, vertical specific products and value-added services to deliver unmatched standards of service quality to its customers. Blue Dart's market leadership is further validated by its position as the nation's most innovative and awarded express logistics company for exhibiting reliability, superior brand experience and sustainability which include recognition as one of 'India's Best Companies to Work For' by The Great Place to Work® Institute, India, ranked amongst 'Best Multinational Workplaces in Asia' by The Great Place to Work® Institute, Asia, voted a 'Superbrand' and 'Reader's Digest Most Trusted Brand', listed as one of Fortune 500's 'India's Largest Corporations' and Forbes 'India's Super 50 Companies' to name a few. Blue Dart's Diversity and Inclusion initiatives have also led to it being recognized as one of India's 'Best Workplaces for Women' in 2021 and 'Best Organizations for Women' in 2022 by the Economic Times.

Blue Dart fulfils its social responsibility of climate protection (GoGreen), disaster management (GoHelp) and education (GoTeach) through its GoPrograms.

Our vision is to establish continuing excellence in delivery capabilities focused on the individual customer. In pursuit of sustainable leadership in quality services, we have evolved an infrastructure unique in the country today:

  • State-of-the-art Technology, indigenously developed, for Track and Trace, MIS, ERP, Customer Service, Space Control and Reservations.
  • Blue Dart Aviation, dedicated capacity to support our time-definite morning deliveries through night freighter flight operations.
  • A countrywide Surface network to complement our air services.
  • Warehouses at 85 locations across the country as well as bonded warehouses at the 7 major metros of Ahmedabad, Bangalore, Chennai, Delhi, Mumbai, Kolkata and Hyderabad.
  • ISO 9001:2015 countrywide certification by Lloyd's Register Quality Assurance for our entire operations, products and services.
  • E-commerce B2B and B2C initiatives including partnering with some of the prime portals in the country.
User Guide

Get Access

You must request credentials for any applications you develop.

To register your app and get your API subscription keys:

  1. Click My Apps on the portal website.
  2. Click Add Developer App.
    The "Add App" form appears.
  3. Complete the Add App form.
    You can select the APIs you want to access.
  4. When you have completed the form, click the Add App button.
    The "Approved" label will appear next to the app name when the app has been approved.
    Note: Additional verification steps may be required for some applications.

Authentication

To view your API subscription keys:

  1. From the My Apps screen, click on the name of your app.
    The Details screen appears.
  2. If you have access to more than one API, click the name of the relevant API.
    Note: The APIs are listed under the "Credentials" section.
  3. Click the Show link below the asterisks that is hiding the Consumer Key.
    The Consumer Key and secret appears.

Generate Token

Every call to the API requires a JWT token is must which customer need to generate before making the actual API call.

Below are the steps to generate the token

  1. Once the App is created in the above steps the customer need to use its keys and secret to make a call to Authenticator API which will generate token.
  2. Link: Authenticator API
  3. Once the token is created customer will send the token in header along with the request payload to its API to perform the specific operation.

Environments

The addressable API base URL/URI environment is:

Environment Description
https://apigateway.bluedart.com/in/transportation/cancel-pickup/v1 Prod Enviornment

How to address Cancel Pickup Registration

The Cancel pickup registration API exposes cancel pickup as its method to cancel the shipment initially ordered by the customer.

Cancel Pickup

Addressing should required the request to be in below format

If you wish to address your need to provide user data and information Pickup, please follow the steps below:

  1. .Request Object which contains all information require to register a cancel the shipment.
  2. Profile which is a user data.

The API sample response below provides all necessary data:

Sample Request Data for :

Request Object
Profile Object

{
"request": {
"PickupRegistrationDate": "/Date(1653485501000)/",
"Remarks": "",
"TokenNumber": 748984
},
"profile": {
"Api_type": "S",
"LicenceKey": "APIKEY",
"LoginID": "APIID"
}
}

...

Additional Information

Permitted HTTP methods
  • Post method for creating a request
Example requests to the API

Simple HTTP request example:

curl --location 'https://apigateway.bluedart.com/in/transportation/cancel-pickup/v1' \

--header 'JWTToken: pass the token' \

--header 'Content-Type: application/json' \

--data '{
"request": {
"PickupRegistrationDate": "/Date(1653485501000)/",
"Remarks": "",
"TokenNumber": 748984
},
"profile": {
"Api_type": "S",
"LicenceKey": "APIKEY",
"LoginID": "APIID"
}
}'

...

Scope

Bluedart Other Services

BlueDart APIS Description
Blue Dart Authentication API Authenticator
BD-Registration for Pickup Registration
BD-Product and Sub-Product Pickup Detail Product
BD-Tracking Of Shipment Tracking
BD-Transit Time Transit Time
BD-Waybill Waybill
BD-Location Finder Finder
BD-Master Download Master Download
BD-Alt-Instruction Alt-Instruction
Legal Terms
Specifics for the use of BlueDart API
Test

To start testing

Test Info

Info

1.0.0
06.Apr.2023
  • Initial Release
  • Contains the abstract of Cancel Pickup Registration API functionality
1.0.1
15.Jun.2023
  • Addition of Sandbox URL