Scribd
Upload
34 views

LCS-Push_API_Documentation

The Leopards Push API allows users to receive status updates for consignments via a callback URL, utilizing standard HTTP POST requests. Users must provide an API callback URL, credentials, and can expect data in JSON format with specific status codes for success or errors. The API supports various shipment statuses that will be pushed from the LCS ECOM Portal to the specified webhook.

Uploaded by

M Mubeen Ali
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
34 views

LCS-Push_API_Documentation

The Leopards Push API allows users to receive status updates for consignments via a callback URL, utilizing standard HTTP POST requests. Users must provide an API callback URL, credentials, and can expect data in JSON format with specific status codes for success or errors. The API supports various shipment statuses that will be pushed from the LCS ECOM Portal to the specified webhook.

Uploaded by

M Mubeen Ali
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
You are on page 1/ 5

LEOPARDS PUSH API DOCUMENTATION

Version 1.0
Leopards API Documentation
API Method: Push Consignment Status (version: 1.0)
Introduction

This document describes the push consignment status API. The API will push the status updates
when new status is updated on any of your consignments on the LCS ECOM Portal via provided
callback URL.

Because the Leopards API is based on open standards, you can use any web development
language to implement this on your end.

To implement this, you have to create a callback URL. And it will be the standard HTTP method
like POST.

Please provide the following details:

 API callback URL, which accepts POST requests.


 API Credentials including API key and API secret key, if any. It will be sent in request
headers.
 Custom request headers, if any.
Request

We will post data in JSON format like:


{

"data": [

"cn_number": "string",

"status": "string",

"receiver_name": "string",

"reason": "string",

"activity_date": "yyyy-mm-dd H:i:s"

},

"cn_number": "string",

"status": "string",

"receiver_name": "string",

"reason": "string",

"activity_date": "yyyy-mm-dd H:i:s"

]
}

Response
In case of success your API method will return the following:
Status_code 202
The result in JSON format like:
[

"status": 1,

"errors": []

]
In case of error your API method will return the following:

In case of Unauthorized request

status_code: 401

In case of Bad/Invalid or unprocessable request

status_code: 400

The result in JSON format like:


[

"status": 0,

"errors": [

"String"

},

]
Shipment Journey

Following statuses will be pushed from LCS to the web hook.

Serial
Status Name Status short code
No.
1 Consignment Booked (Shipment Scanned In LCS Facility) RC
2 Assigned To Courier (Out For Delivery) AC
3 Delivered (Terminal Status) DV
4 First Attempt In Forward Leg PN1
5 Second Attempt In Forward Leg PN2
6 Being Return RO
7 First Attempt In Reverse Leg RN1
8 Second Attempt In Reverse Leg RN2
9 Returned to Warehouse (Terminal Status) RW
10 Delivered to Warehouse (Terminal Status) DW
11 Returned to Shipper (Terminal Status) RS
12 Delivered to Vendor (Terminal Status) DR
13 Arrived At Station AR
14 Dispatched DP
15 Ready for Return NR
16 Shipment Picked SP

You might also like