Introduction
To use Speedlink Services APIs, you should first learn the various aspects of Speedlink® services. This documentation enables you to gather Speedlink Services shipping business knowledge and understand various shipping options, rules and guidelines. These resources will help you with answers to all your questions related to the shipping domain and equip you to use Speedlink Services APIs for your shipments.
Pincode Service List
Pre-Check Pincode list of Services.
Method : GET,All Parameter Should be Send Body Form-Data Format Only
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | service-pincode | --- |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key |
Response:
note *: output will be send only JSON encode format
{
"error": false,
"status_code": "200",
"status": "Success",
"total_pincode": 743,
"output":
[
{
"id": "7",
"pin_code": "560027",
"city": "Bangalore",
"state": "KARNATAKA",
"service": "No",
"air": "Yes",
"road": "Yes",
"tat": "24",
"area_code": "BLR"
},
{
"id": "9",
"pin_code": "560038",
"city": "BANGALORE",
"state": "KARNATAKA",
"service": "No",
"air": "Yes",
"road": "Yes",
"tat": "ew",
"area_code": "wer"
},
{
"id": "10",
"pin_code": "560048",
"city": "BANGALOUR",
"state": "KARNATAKA",
"service": "Yes",
"air": "Yes",
"road": "Yes",
"tat": "",
"area_code": ""
}
]
}
Check Pincode Available Or Not
Check Particale Pincode Service Available Or Not
Method : GET,All Parameter Should be Send Body Form-Data Format Only
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | check-service-pincode-availability | --- |
| pincode* | 560027 | --- |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key |
Response:
note *: output will be send only JSON encode format
{
"error": true,
"status_code": "500",
"status": "Failure",
"message": "560027 this pincode service currently not available",
"output": [
{
"id": "7",
"pin_code": "560027",
"city": "Bangalore",
"state": "KARNATAKA",
"service": "No",
"air": "Yes",
"road": "Yes",
"tat": "24",
"area_code": "BLR"
}
]
}
Awb number Request
Get AWB Number
Method : POST,All Parameter Should be Send Body Form-Data Format Only
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | awb-number-request | --- |
| client_id* | ** | - |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key |
Response:
note *: output will be send only JSON encode format
{
"error": false,
"status_code": "200",
"status": "Success",
"awb_number": "1000006",
"message": "awb number fetched successfully"
}
Bulk Awb number Request
Get AWB Number
Method : POST,All Parameter Should be Send Body Form-Data Format Only
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | bulk-awb-number-request | --- |
| client_id* | ** | - |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key |
| limit* | 10 | 10 or 1000 etc |
Response:
note *: output will be send only JSON encode format
{
"error": false,
"status_code": "200",
"status": "Success",
"count": 5,
"awb_numbers": [
{
"awb_code": "1507168"
},
{
"awb_code": "1507169"
},
{
"awb_code": "1507170"
},
{
"awb_code": "1507171"
},
{
"awb_code": "1507172"
}
],
"message": "awb number fetched successfully"
}
Shipment Create
Method : POST
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | shipment-create | --- |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key |
| awb_number* | ***** | |
| dp_code* | (New Parameter Required..) | |
| client_id* | 1 | If sended client id not existing in our panel that showing error message..if error came can't add shipment |
| pincode* | 560027 | If sended pincode not existing or pincode service un-available in our panel that showing error message..if error came can't add shipment. based on pincode customer city,state,destinaton automatically fetched. |
| customer_name* | XXXXX | customer name should be required |
| mobile_number* | XXXXX | mobile number should be required |
| address* | XXXXX XXXXX XXXXX |
customer address should be required |
| no_of_box (optional) | XXXXX XXXXX XXXXX |
only number format -optional |
| picklist_no (optional) | XXXXX XXXXX XXXXX |
optional |
| invoice_value (optional) | XXXXX XXXXX XXXXX |
optional |
| weight (optional) | XXXXX XXXXX XXXXX |
only number format -optional |
Response:
note *: output will be send only JSON encode format
{
"error": true,
"status_code": "500",
"status": "Failure",
"message": "mobile_number required"
}
Shipment Tracking
Method : POST
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | shipment-tracking | --- |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key |
| awb_number* | 423534 | |
Response:
note *: output will be send only JSON encode format
{
"error": false,
"status_code": "200",
"status": "Success",
"output": [
{
"shipment_info": {
"awb_number": "535836",
"current_status": "Delivered",
"customer_name": "TEJAMURTHY.N.M ",
"no_of_box": "1",
"destination_city": "DVG-CHANNAGIRI",
"date": "2022-03-07"
}
},
{
"shipment_tracking": [
{
"status_updated_date": "2022-03-07",
"status": "pending",
"message": "Shipment soft data uploaded successfully"
},
{
"status_updated_date": "2022-03-07",
"status": "picked",
"message": "Entry Successfully Picked"
},
{
"status_updated_date": "2022-03-07",
"status": "In Transit",
"message": ""
},
{
"status_updated_date": "2022-03-08",
"status": "Received at destination",
"message": ""
},
{
"status_updated_date": "2022-03-09",
"status": "Out for delivery",
"message": ""
},
{
"status_updated_date": "2022-03-09",
"status": "Delivered",
"message": ""
}
]
}
]
}
Bulk Shipment Tracking With Date
Method : POST
|
||
|---|---|---|
| Parameter | Example Value | Parameter Explanation |
| type* | shipment-tracking | --- |
| date* | Y-m-d ex : 2022-08-01 | --- |
| authorization_code* | SPL-XXXXXXXXXXXXXXXXXX | Secred Key Based on client shipment tracking showing |
Response:
note *: output will be send only JSON encode format
{
"error": false,
"status_code": "200",
"total_shipment_count": 228,
"status": "Success",
"output": [
{
"shipment_info": {
"awb_number": "1003704",
"current_status": "picked",
"invoice_value": null,
"weight": "0.86",
"picklist_no": null,
"customer_name": "RANUSHA",
"no_of_box": "1",
"destination_city": "TUMKUR ",
"date": "2022-08-03"
}
},
{
"shipment_info": {
"awb_number": "305506",
"current_status": "picked",
"invoice_value": null,
"weight": "1.76",
"picklist_no": null,
"customer_name": "GAJANAND",
"no_of_box": "1",
"destination_city": "BIDAR",
"date": "2022-08-03"
}
}
]
}
Response Error Details
Status :Success
Status Code : 200
Status Code : 200
Status :Failure
Status Code : 500
Status Code : 500
Status :Forbidden
Status Code : 403
Status Code : 403
Status :Bad Request
Status Code : 400
Status Code : 400