# Shiprocket

## 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

<figure><img src="/files/33hzvBh63EM6kmp9EJWc" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/HmXdnzlIbvzIY07j1a5O" alt=""><figcaption></figcaption></figure>

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

&#x20;👉 These channels are not used if we are tracking via AWB number

4. Go to Channels

<figure><img src="/files/NjsU6PIYXwmiL3w4kdI8" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/1Thxkgdd89X4aL0Atvz0" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://limechatai.gitbook.io/limechat-product-guide/automation/integrations/courier-aggregator/shiprocket.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.