Scribd
Upload
191 views

DTDC Customer Level Cancellation API Documentation

DTDC API for delivery

Uploaded by

stabiron.ezimax
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
191 views

DTDC Customer Level Cancellation API Documentation

DTDC API for delivery

Uploaded by

stabiron.ezimax
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

DTDC Customer Level Cancellation

API Documentation

Sandbox endpoint

POST

Path: Base Url + “/api/customer/integration/consignment/cancel”

Base url would depend on the environment:

for demo : “https://demodashboardapi.shipsy.in”

for production : “http://dtdcapi.shipsy.io/”

Api-key: (Shared by DTDC team)

Add the basic authentication also.

Set ‘Content-Type’ header to ‘application/json’

Sample Body

"AWBNo": ["G12340262"],
"customerCode":"XYZ"
}
Following is the description, its data type, whether required or not and possible example for the
body
Key Name Description Data Type Required
Remarks
Key

AWBNo
Consignment Array Array of

stringyes Example [“V12345678”]

customerCode
Customer Code String yesExample ““CUSTOMER001”

Response

Response Codes
Response Code Remarks

200 The consignments are canceled- if success is true , otherwise some or all
of them have error

400 There is some validation error in the overall request format. In this
case, complete request is rejected

401 There is authentication error

Sample Response for 200


When the response is 200, it means that there is no error in the structure of the request.

Below is the sample response for a request in which all the consignments of the array AWBNo
is canceled.
{
"status": "OK",
"success": true
}
The above response means that:
● All the consignments are canceled
When response is 200 , and there are some / all consignments which are not canceled.

Below is the sample response when all/ some consignments are not canceled.

{
"status": "OK",
"success": false,
"failures": [
{
"reference_number": "G12340262",
"message": "Consignment does not belong to the client",
"reason": "CONSIGNMENT_DOES_NOT_BELONG_TO_CLIENT"
}
]
}

Sample Response for 400


{

"error": {

"message": "Customer Code should be present",

"statusCode": 400,

"reason": "WRONG_INPUT",

"code": "CUSTOMER_CODE_MISSING",

There is an “error” key, which has the error object. Error object contains
● “message”: Error description
Sample Response for 401
- If the basic auth credentials are not present{
"error": {
"message": "API key should be present",
"reason": "NO_API_KEY"
}
}
- If wrong basic auth credentials are used
{
"error": {
"message": "Wrong api key",
"statusCode": 401,
"reason": "WRONG_API_KEY"
}
}

There is an “error” key, which has the error object. Error object contains
● “message”: Error description
● “reason”: Error code

You might also like