Skip to main content

🚛

ShipRocket - Order / Tracking ID API

Client Side Requirements: API_USER_EMAIL API_USER_PASSWORD CHANNEL_ID
Track: Order ID Tracking ID


Overview​

LimeChat has a seamless integration with ShipRocket which allows us to do the following:

  1. Use their API to fetch the status of orders (Used for automating order tracking queries via the bot)
  2. Listen to their webhooks when a delivery has failed (NDR, etc) in order to send out message campaigns via WhatsApp

Follow the steps below to set up the integration 👇​

Integration​

ShipRocket allows us to track the order status via two APIs

  1. via Order ID
  2. via Tracking ID (AWB number)

To use the APIs we need to generate an Authentication Token which requires the following credentials

  1. API User Username
  2. API User Password
  3. List of Channel IDs

Share the following information with your dedicated LimeChat Product Consultant to complete the integration.


How to fetch your Credentials?​

Create an API User​

We need to create a specific API User in the ShipRocket system which will allow LimeChat to use the ShipRocket API. This can be done in 3 easy steps.


1️⃣ On your ShipRocket dashboard, find the option for API



2️⃣ Create an API User and register with an email and password of your choice



3️⃣ Enter an email id and password which has not been used for API user creation before. Set its state to Active in the Active/Deactive column.



Get the list of all Channel Names / IDs​

Channel IDs help us identify which channel to pick up the logistics information from. There can be multiple configured channel IDs for any brand. LimeChat will need a list of all of them to make sure it is able to track the order status irrespective of the channel



4️⃣ Go to Channels



5️⃣ Copy the channel ID of all the Active Channels and share with LimeChat team