Getting Started With Shyplite API

Sections in this article

The Shyplite API is organized as a REST API. All URLs are resource oriented unless otherwise mentioned. They are all state-less.

The base URL for all endpoints is: https://api.shyplite.com/.

Our API is HTTPS only and all calls to the HTTP endpoint will be redirected automatically. This behaviour may change in the future where connections to the HTTP endpoints are rejected completely.

We currently only support the application/json response format.

Shyplite APIs are rate limiting APIs and requests are limited to 10 request/second. If you send more than 10 requests per second, the API will return a 429 response at which you should throttle your requests for a second or two.

Please note authetication version 2 will be discontinued soon thus use the authentication version 3 only.

Authentication API

  • Go to Settings » API » Click on Enable
  • You will get four keys which are required for Authentication: Seller ID, App ID, Public Key, Private Key.
  • Click Here to check out the Authentication API Document.

Note:

  • Private Key is temporarily shown due to security reasons thus please make a special note of it for future use.
  • Please note authetication version 2 will be discontinued soon thus use the authentication version 3 only.

Orders API

  • Overview: Orders API is for the booking of an order.

  • Request: In request you have to give the order details in this API for booking of an order. Please note: all the fields are mandatory unless mentioned specifically.

  • Response: In response it will give success as response on successful booking, else will give an error or failure which needs to be fixed for booking of that particular order.

  • Click Here to check out the Orders API Document.

Note: You can book only 1 order per request.


Shipments API

  • Overview: Shipments API is for the fetching shipping label.

  • Request: In request you have to pass the order ID which you have booked via Order API.

  • Response: In response you will receive Carrier Name, AWB Number, File path, File Name and Manifest ID.

  • Click Here to check out the Shipments API Document.

Note:

  • Shipment API response will return a s3Path key which contains the URL on which the file is hosted. You can then use any file download tool to fetch the file.
  • You can get the shipping label before it gets picked up i.e. the order is in Booked status, once the order is moved in transit, you would not be able to fetch the shipping label.

Manifest API

  • Overview: Manifest API is for the fetching Manifest file.

  • Request: In request you have to pass the Manifest ID which you have received in response of Shipments API.

  • Responst: In response you will receive File path and File Name.

  • Click Here to check out the Manifest API Document.

Note:

  • Manifest API response will return a s3Path key which contains the URL on which the file is hosted. You can then use any file download tool to fetch the file.
  • On downloading the manifest, the manifest status will be changed from “Open” to “Closed” on the Manifest Page of Shyplite panel.
  • Also, shipments need to be bulk manifested after booking of all the orders, it should not be manifested individually.

Tracking API

  1. Tracking via Tracking Number
  2. Bulk Tracking via Tracking Number
  3. Bulk Tracking via Order ID

Tracking Event Status Codes

  • SB = “Shipment Booked”
  • PU = “Picked Up”
  • IT = “In Transit”
  • EX = “Exception”
  • OD = “Out for Delivery”
  • OP = “Out for Pickup”
  • RT = “Return”
  • DL = “Delivered”

1. Tracking via Tracking Number

  • Overview: Tracking API is for the fetching Tracking events of a Shipment.

  • Request: In request you have to pass one AWB Number which you have received in response of Shipments API.

  • Response: In response you will receive Carrier Name, AWB Number and Tracking events

  • Click Here to check out the Tracking API Document.

2. Bulk Tracking via Tracking Number

  • Overview: Tracking API is for the fetching Tracking events of a Shipment.

  • Request: In request you have to pass the AWB Number(s) which you have received in response of Shipments API.

  • Response: In response you will receive Carrier Name, AWB Number and Tracking events

  • Click Here to check out the Tracking API Document.

Note: Maximum 50 awbs can be tracked at once.

3. Bulk Tracking via Order ID

  • *Overview: Tracking API is for the fetching Tracking events of a Shipment.

  • Request: In request you have to pass the order ID(s) which you have received in response of Shipments API.

  • Response: In response you will receive Carrier Name, AWB Number and Tracking events

  • Click Here to check out the Tracking API Document.

Note: Maximum 50 order IDs can be tracked at once.


Serviceability API

  • Overview: Serviceability API gives the services between Pickup Pin code and Drop Pin code.

  • Request: You have to pass the Pickup Pin code and Drop Pin code in the URL itself.

  • Response: In response you will receive set of services which will have pairing of Mode Type and Order Type. True indicates that the service is available and False indicates that it is non-serviceable.

  • Click Here to check out the Serviceability API Document.


Price Calculator and Serviceability API

  • Overview: Price Calculator API is for checking the estimated rates for shipping a particular shipment.

  • Request: You have to pass the Pickup Pin code and Drop Pin code, Order Type, Mode Type, Length (cm), Breadth (cm), Height (cm), Weight (kg), Invoice Value.

  • Response: In response you will receive the estimated price.

  • Click Here to check out the Price Calculator API Document.

Note:

  • This API will give the rates irrespective of the serviceability, thus either check the serviceability along with rates for a particular mode or send the request without mode to get servicibility and estimated prices for all the modes.
  • This API give the estimated prices only, actual price may differ. The estimated prices are inclusive of 18% GST.

Cancel Order API

  • Overview: Cancel Order API is for the fetching shipping label.

  • Request: In request you have to pass the order ID(s) which you wish to cancel.

  • Response: In response you will receive true and false against the respective order IDs. True indicates that the Order is successfully cancelled and False indicates that the Order cancellation is failed.

  • Click Here to check out the Cancel Order API Document.

Note: An order cannot be cancelled if it gets picked up, only Orders which are in Booked state can be cancelled via this API.

If you have any questions that are not addressed, please feel free to reach Shyplite Support.