API Speccification (TTT)

01-JUNE-2022
API - Essential Logistics TMS (PRODUCTION)
1. Booking API
REST API URL (SAMPLE): https://<API_URL>/create-docket.php?auth_key=h9r9n7MGx7
Request Type: POST
Header:
APIKEY (auth_key): h9r9n7MGx7
Request Body:
{
"PickUpDetails": [
{
"DocketNo" : "5031503",
"DocketDate": "2020-01-11",
"RefNo": "111111",
"ContactPersonName": "Dhanush Agarwal",
"MobileNo": "9153660987",
"TelephoneNo": "03323565671",
"ConsignorName": "ABCD Pvt.Ltd",
"ConsignorAddress": "No 31/3, Adakimaranahalli, Makali Post, Da
sanapuraHobli, Bengaluru -562162 ",
"ConsignorCity": "Bengaluru",
"ConsignorPin": "562162",
"ConsigneeName": "XYZ Pvt.Ltd",
"ConsigneeAddress": "5/A Gulab Estate, Safed Pool, Sakinaka, T2
Link Road, Andheri Kurla Road, Mumbai, Maharashtra, 400072",
"ConsigneeCity": "Mumbai",
"ConsigneePin": "400072",
"DocRefNo": "CAB258645",
"ShipmentWeight": "430",
"NoOfCartons": "20",
"ProductDescription":"Automobile",
"ProductValue": "1270000",
"InvoiceDetails": [
{
"EwayBill": "1234",
"EwayBillDate": "2020-03-02",
"EwayExpDate": "2020-03-10",
"InvoiceNo": "4564345345",
"InvoiceValue": "42333.33"

},
{
"EwayBill": "788633",
"EwayExpDate": "2020-03-10",
"InvoiceNo":"34572245234",

},
{
"EwayBill": "29876",
"EwayExpDate": "2020-03-10",
"InvoiceNo": "4564345345",

}],
"BoxDetails":[
{
"Length": "1",
"Breadth": "2",
"Height": "3",
"Pkgs":"7"
},
{
"Length": "1",
"Breadth": "2",
"Height": "3",
"Pkgs":"7"
},
{
"Length": "1",
"Breadth": "2",
"Height": "3",
"Pkgs":"6"
}]
},
{
"DocketNo" : "5031504",
"DocketDate": "2020-01-11",
"RefNo": "111111",
"ContactPersonName": "Dhanush Agarwal",
"MobileNo": "9153660987",
"TelephoneNo": "03323565671",
"ConsignorName": "ABCD Pvt.Ltd",
"ConsignorAddress": "No 31/3, Adakimaranahalli, Makali Post, Da
sanapuraHobli, Bengaluru -562162 ",
"ConsignorCity": "Bengaluru",
"ConsignorPin": "562162",
"ConsigneeName": "XYZ Pvt.Ltd",
"ConsigneeAddress": "5/A Gulab Estate, Safed Pool, Sakinaka, T2
Link Road, Andheri Kurla Road, Mumbai, Maharashtra, 400072",
"ConsigneeCity": "Mumbai",
"ConsigneePin": "400072",
"DocRefNo": "CAB258645",

"ShipmentWeight": "430",
"NoOfCartons": "20",
"ProductDescription":"Automobile",
"ProductValue": "1270000",
"InvoiceDetails": [
{
"EwayBill": "1234",
"EwayExpDate": "2020-03-10",
"InvoiceNo": "4564345345",

},
{
"EwayBill": "788633",
"EwayExpDate": "2020-03-10",
"InvoiceNo":"34572245234",

},
{
"EwayBill": "29876",
"EwayExpDate": "2020-03-10",
"InvoiceNo": "4564345345",

}],
"BoxDetails":[
{
"Length": "1",
"Breadth": "2",
"Height": "3",
"Pkgs":"7"
},
{
"Length": "1",
"Breadth": "2",
"Height": "3",
"Pkgs":"7"
},
{
"Length": "1",
"Breadth": "2",
"Height": "3",
"Pkgs":"6"
}]
}
]
}
Dataload
Element Data Type Data Value
Length
DocketNo Numeric 8 required
DocketDate Date (YYYY-MM- required

DD)
RefNo (to keep Alphanumeric 15

customer reference
for each record)
ContactPersonName Alphabetic 50
MobileNo Numeric 10
TelephoneNo Numeric 11
ConsignorName Alphanumeric 200 required
ConsignorAddress Alphanumeric 200 required
ConsignorCity Alphabetic 50 required
ConsignorPin Numeric 6 required
ConsigneeName Alphanumeric 200 required

ConsigneeAddress Alphanumeric 200 required
ConsigneeCity Alphabetic 50 required
ConsigneePin Numeric 6 required
DocRefNo Alphanumeric 12
ShipmentWeight Decimal(Two 10,2 required

Decimal)
NoOfCartons Numeric 4 required
ProductDescription Alphanumeric 100
ProductValue Decimal(Two 10,2 required

Decimal) (In INR)
EwayBill Alphanumeric Array 12

data
EwayBillDate Date(YYYY-MM-
DD) Array data
EwayExpDate Date(YYYY-MM-
DD) Array data
InvoiceNo Alphanumeric Array 20

data
InvoiceValue Numeric Array data
Length Numeric Array data in centimeter
Breadth Numeric Array data in centimeter
Height Numeric Array data in centimeter
Pkgs Numeric Array data
Response:
1>Success
{
" BookingDetails ": [{

“RefNo”: 111112,
"DocketNo":”02031504“,
“StatusCode”: 200,
“Status”: “Data Saved Successfully”
},
"RefNo": 111113,
“DocketNo”: 02031505,
“StatusCode”: 400,
“Status”: “Consignor Name is mandatory”
}]
2>Failure
" StatusCode ": "400",
“Msg": "API Key validation FAILED”
Other Failures Messages
1>“Status": "Consignor Name is mandatory”
2>“Status": "Consignor Address is mandatory”
3>“Status": "Consignor City should be alphabetic and mandatory”
4>“Status": "Consignor Pin should be numeric and mandatory”

5>“Status": "Consignee Name is mandatory”
6>“Status": " Consignee Address is mandatory”
7>“Status": "Consignee City should be alphabetic and mandatory”
8>“Status": "Consignee Pin should be numeric and mandatory”
9>“Status": "Shipment Weight should be Numeric or Decimal(Two Decimal places) and mandatory”
10>“Status ": "No Of Cartons should be Numeric and mandatory”
11>“Status": "Product Value should be Decimal(Two Decimal places) and mandatory”
12>“Status": "Docket No. Does not exist or not allocated to you”
13>“Status": "Docket Date Does not exist or not in proper format”
2. Tracking API
REST API URL(SAMPLE): https://<API_URL>/docket-tracking.php? auth_key=h9r9n7MGx7
Request Type:POST
Header :
APIKEY(auth_key:h9r9n7MGx7
Request Body:
{
"cn_no":[215881,20739681]
}
Response Body:
1>Success
{
"statustracking": [
{
"Shipment": {
"DocketNumber": "00215881",
"OrderNumber": "",
"InvoiceNumber": "1822288252",
"NumberOfBoxes": "2",
"NetValue": "18367.00",
"Origin": "BANGALORE",
"OriginPostalCode": "",
"Destination": "BHIWANDI",
"DestinationPostalCode": "",
"PickUpDate": null,
"pickUpTime": "",
"Weight": "9.00",
"ShipmentMode": "S",
"expectedDeliveryDate": "01-02-2022",
"Scans": {
"ScanDetail": [
{
"ScanCode": "INT",
"Scan": "SHIPMENT IN-TRANSIT",
"ScanDate": "30-01-2022",
"ScanTime": "1703",
"ScannedLocationCode": "SBC",
"ScannedLocation": "BANGALORE",
"ScannedLocationStateCode": "",
"Status TimeZone": "IST",
"Comments": "",
“UnDelReason”:””,
"StatusLatitude": "",
"StatusLongitude": ""
}
],
"DeliveryDetails": "",
"POD": ""
}
}
}
]
}
2>Success
{
"statustracking": [
{
"Shipment": {
"DocketNumber": "00215881",
"OrderNumber": "",
"InvoiceNumber": "1822288252",
"NumberOfBoxes": "2",
"NetValue": "18367.00",
"Origin": "BANGALORE",
"OriginPostalCode": "",
"Destination": "BHIWANDI",
"DestinationPostalCode": "",
"PickUpDate": null,
"pickUpTime": "",
"Weight": "9.00",
"ShipmentMode": "S",
"expectedDeliveryDate": "01-02-2022",
"Scans": {
"ScanDetail": [
{
"ScanCode": "DEL",
"Scan": "SHIPMENT DELIVERED",
"ScanDate": "18-05-2021",
"ScanTime": "1458",
"ScannedLocationCode": "DHL",
"ScannedLocation": "DHULAGARH",
"ScannedLocationStateCode": "",
"Status TimeZone": "IST",
"Comments": "",
“UnDelReason”:””,
"StatusLatitude": "",
"StatusLongitude": ""
}
],
"DeliveryDetails": {
"ReceivedBy": "",
"Relation": "",
"IDType": "",
"IDNumber": "",
"IDImage": "",
"Signature": ""
},
"POD": "http://<DOMAIN_URL>/item_images/00215881.jpg"
}
}
}
]
}
Scan Codes with Descriptions:
ScanCode Scan Description

BOO SHIPMENT BOOKED
INT SHIPMENT IN-TRANSIT
ITR SHIPMENT ARRIVED AT DESTINATION
OOD SHIPMENT OUT FOR DELIVERY
DEL SHIPMENT DELIVERED
UDEL SHIPMENT UnDELIVERED

API Speccification (TTT)

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API Speccification (TTT)

Uploaded by

Copyright:

Available Formats

01-JUNE-2022

API - Essential Logistics TMS (PRODUCTION)

Request Type: POST

APIKEY (auth_key): h9r9n7MGx7

DocketNo Numeric 8 required

DocketDate Date (YYYY-MM- required

RefNo (to keep Alphanumeric 15

ConsignorName Alphanumeric 200 required

ConsignorAddress Alphanumeric 200 required

ConsignorCity Alphabetic 50 required

ConsignorPin Numeric 6 required

ConsigneeName Alphanumeric 200 required

ConsigneeCity Alphabetic 50 required

ConsigneePin Numeric 6 required

ShipmentWeight Decimal(Two 10,2 required

NoOfCartons Numeric 4 required

ProductDescription Alphanumeric 100

ProductValue Decimal(Two 10,2 required

EwayBill Alphanumeric Array 12

InvoiceNo Alphanumeric Array 20

InvoiceValue Numeric Array data

Length Numeric Array data in centimeter

Breadth Numeric Array data in centimeter

Height Numeric Array data in centimeter

Pkgs Numeric Array data

" BookingDetails ": [{

“Status”: “Data Saved Successfully”

“Status”: “Consignor Name is mandatory”

" StatusCode ": "400",

“Msg": "API Key validation FAILED”

Other Failures Messages

1>“Status": "Consignor Name is mandatory”

2>“Status": "Consignor Address is mandatory”

3>“Status": "Consignor City should be alphabetic and mandatory”

4>“Status": "Consignor Pin should be numeric and mandatory”

6>“Status": " Consignee Address is mandatory”

7>“Status": "Consignee City should be alphabetic and mandatory”

8>“Status": "Consignee Pin should be numeric and mandatory”

10>“Status ": "No Of Cartons should be Numeric and mandatory”

11>“Status": "Product Value should be Decimal(Two Decimal places) and mandatory”

12>“Status": "Docket No. Does not exist or not allocated to you”

13>“Status": "Docket Date Does not exist or not in proper format”

ScanCode Scan Description

You might also like