Scribd
Upload
9 views4 pages

SpeedoPost API Documentation

The SpeedoPost API documentation outlines the process for obtaining an authentication token, which is valid for 24 hours, and provides details on two main APIs: the Token API for generating tokens and the Tracking Packet Status API for tracking order statuses. The Token API requires a POST request with user credentials, while the Tracking API requires a GET request with specific query parameters and a bearer token. Success and failure response formats are provided for both APIs, detailing the expected data structure and potential error messages.

Uploaded by

Pradeep Singh
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
9 views4 pages

SpeedoPost API Documentation

The SpeedoPost API documentation outlines the process for obtaining an authentication token, which is valid for 24 hours, and provides details on two main APIs: the Token API for generating tokens and the Tracking Packet Status API for tracking order statuses. The Token API requires a POST request with user credentials, while the Tracking API requires a GET request with specific query parameters and a bearer token. Success and failure response formats are provided for both APIs, detailing the expected data structure and potential error messages.

Uploaded by

Pradeep Singh
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Speedo Post Api Doc

Introduction
Before accessing SpeedoPost api you neeed to getting Authentication token and token
will be expired in 24 hour. For further access api you need regenerate new token.

1- Token API-
API URL : [Link]
Request Method : POST
Headers:

TYPE VALUE
Content-Type application/json

REQUEST DATA:
Sample JSON request –
{

"userId": "93697151**",
"password": "123222"
}

Explanation of Fields:

Field Name Data Type Type Description


userId String/Varchar Mandatory Client login user id
Mandatory Client Password

password String/Varchar

Success Response Data:


{
"status": "SUCCESS",
"message": null,
"response":
"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5MzY5NzE1MTA0IiwiZXhwIjoxNzE0NzI4OTcwLCJpYXQiOjE3M
TQ2NDI1NzB9.puwTwJJ19-RwCx7GKEMRfPiAEfL9-uHCA_REKoiZsGE"
}
Fail Response Data:
{
"status": "FAIL",
"message": "Invalid username or password.",
"response": null
}
2- Tracking Packet Status API :
Introduction
Track Status Web Service allows the Client partners to track status of their
orders from SpeedoPost System.

API URL : [Link]


Number>&trackingType=< AWB/>

Request Method : GET

Headres

TYPE VALUE
Content-Type application/json
Authorization <Bearer Token>

Query Parameters

TYPE VALUE
awb SpeedoPost Awb number or Partner awb number
trackingType AWB / VENDOR-AWB
If track to SpeedoPost Awb then trackingType will
be “AWB”
If track to Partner Awb then trackingtype will be
“VENDOR-AWB”

Success Response Data:


{
"status": "SUCCESS",
"message": null,
"response": {
"currentStatus": "Delivered",
"currentCode": "10007",
"awbNumber": "20001**",
"packetHistory": [
{
"date": "2022-12-02 22:53:33",
"location": "DHULSIRAS",
"remarks": null,
"statusCode": "10001",
"status": "Order Booked"
},
{
"date": "2022-12-02 16:11:54",
"location": "Gurgaon_Tauru_GW (Haryana)",
"remarks": "Hold as per client instrutions",
"statusCode": "10003",
"status": "Order In-transit"
},
{
"date": "2022-12-03 17:28:42",
"location": "Bangalore_Soukyaroad_GW (Karnataka)",
"remarks": "Hold as per client instrutions",
"statusCode": "10003",
"status": "Order In-transit"
},
{
"date": "2022-12-04 21:12:40",
"location": "Bangalore_Soukyaroad_GW (Karnataka)",
"remarks": "Unlock",
"statusCode": "10003",
"status": "Order In-transit"
},
{
"date": "2022-12-04 23:12:28",
"location": "Bangalore_Soukyaroad_GW (Karnataka)",
"remarks": "Bag Added To Trip",
"statusCode": "10003",
"status": "Order In-transit"
},
{
"date": "2022-12-05 06:45:05",
"location": "Vellore_Avrmpalyam_I (Tamil Nadu)",
"remarks": "Trip Arrived",
"statusCode": "10003",
"status": "Order In-transit"
},
{
"date": "2022-12-05 17:14:07",
"location": "Vellore_Avrmpalyam_I (Tamil Nadu)",
"remarks": "Shipment Delivered",
"statusCode": "10007",
"status": "Delivered"
}
]
}
}
Fail Response Data:
{
"status": "FAIL",
"message": "Invalid token.",
"response": null
}

{
"status": "FAIL",
"message": "Token expired.",
"response": null
}

{
"status": "FAIL",
"message": "Awb number not found.",
"response": null
}

{
"status": "FAIL",
"message": "Tracking type only AWB or VENDOR-AWB",
"response": null
}

You might also like