# Shiprocket

### Snapshot

| Features                        | Details                                                          |
| ------------------------------- | ---------------------------------------------------------------- |
| Release Status                  | Released                                                         |
| Source API Version              | v2                                                               |
| Table Selection                 | Yes                                                              |
| Column Selection                | Yes                                                              |
| Edit Integration                | Yes                                                              |
| Replication Type Selection      | No                                                               |
| Authentication Parameters       | <p>Shiprocket api user email<br>Shiprocket api user password</p> |
| Replication Type                | <p>Key Based Incremental<br>Full Replication</p>                 |
| Replication Key                 | NA                                                               |
| Suggested Replication Frequency | 24 hrs                                                           |

| Tables/APIs Supported |                    |
| --------------------- | ------------------ |
| orders                | return\_orders     |
| shipments             | pickup\_addresses  |
| products              | listings           |
| channel\_details      | inventory\_details |
| country\_codes        | discrepancy\_data  |

### Integrate Shiprocket with Daton

1. Signin to Daton&#x20;
2. Select Shiprocket from Integrations page
3. Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later&#x20;
4. Provide your shiprocket api user email and password to authorize Daton to periodically extract data from shiprocket.
5. Post successful authentication you will be prompted to choose from the list of available tables
6. Then select all required fields for each table
7. Submit the integration

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### SHIPROCKET Data

**Orders**

Purpose: This API call will display a list of all created and available orders in your Shiprocket account. The product and shipment details are displayed as sub-arrays within each order detail.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#9bfbe7a1-0f96-4456-861f-e059165868e4>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| id                    | NUMERIC         |
| channel\_id           | NUMERIC         |
| channel\_name         | STRING          |
| base\_channel\_code   | STRING          |
| channel\_order\_id    | STRING          |
| customer\_name        | STRING          |
| customer\_email       | STRING          |
| customer\_phone       | STRING          |
| pickup\_location      | STRING          |
| payment\_status       | STRING          |
| total                 | STRING          |
| tax                   | STRING          |
| sla                   | STRING          |
| shipping\_method      | STRING          |
| expedited             | NUMERIC         |
| status                | STRING          |
| status\_code          | NUMERIC         |
| payment\_method       | STRING          |
| is\_international     | NUMERIC         |
| purpose\_of\_shipment | NUMERIC         |
| channel\_created\_at  | STRING          |
| created\_at           | STRING          |
| products              | RECORD          |
| shipments             | RECORD          |
| activities            | STRING          |
| allow\_return         | NUMERIC         |
| is\_incomplete        | NUMERIC         |
| errors                | STRING          |
| show\_escalation\_btn | STRING          |
| escalation\_status    | STRING          |
| escalation\_history   | STRING          |

**ReturnOrders**

Purpose: Using this API you can get a list of all created return orders in your Shiprocket account along with their details.

Source API Documentation: <https://apidocs.shiprocket.in/?version=latest#4bf0f6ee-68bd-4629-9e42-9ca09b134dbb>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                  | Target Datatype |
| --------------------- | --------------- |
| id                    | NUMERIC         |
| channel\_id           | NUMERIC         |
| channel\_name         | STRING          |
| base\_channel\_code   | STRING          |
| channel\_order\_id    | STRING          |
| customer\_name        | STRING          |
| customer\_email       | STRING          |
| customer\_phone       | STRING          |
| customer\_pincode     | STRING          |
| pickup\_code          | STRING          |
| pickup\_location      | STRING          |
| payment\_status       | STRING          |
| total                 | STRING          |
| expedited             | NUMERIC         |
| sla                   | STRING          |
| shipping\_method      | STRING          |
| status                | STRING          |
| status\_code          | NUMERIC         |
| payment\_method       | STRING          |
| is\_international     | NUMERIC         |
| purpose\_of\_shipment | NUMERIC         |
| channel\_created\_at  | STRING          |
| created\_at           | STRING          |
| products              | RECORD          |
| delivery\_code        | STRING          |
| cod                   | NUMERIC         |
| shipment\_id          | NUMERIC         |
| in\_queue             | NUMERIC         |
| shipments             | RECORD          |

**Shipments**

Purpose:Use this APi to get the shipment details of all the shipments in your Shiprocket account.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#b3460616-eec8-47b6-8192-1fd172ccdd52>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                | Target Datatype |
| ------------------- | --------------- |
| number              | STRING          |
| code                | STRING          |
| id                  | NUMERIC         |
| order\_id           | NUMERIC         |
| products            | RECORD          |
| awb                 | STRING          |
| status              | STRING          |
| created\_at         | STRING          |
| channel\_id         | NUMERIC         |
| channel\_name       | STRING          |
| base\_channel\_code | STRING          |
| payment\_method     | STRING          |

**PickupAddresses**

Purpose:Get a list of all pickup locations that have been added to your Shiprocket account through this API.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name             | Target Datatype |
| ---------------- | --------------- |
| id               | NUMERIC         |
| pickup\_location | STRING          |
| address          | STRING          |
| address\_2       | STRING          |
| city             | STRING          |
| state            | STRING          |
| country          | STRING          |
| pin\_code        | STRING          |
| email            | STRING          |
| phone            | STRING          |
| name             | STRING          |
| company\_id      | NUMERIC         |
| status           | NUMERIC         |
| phone\_verified  | NUMERIC         |

**Products**

Purpose:This API can be used to display a detailed list of all the products that you have in your Shiprocket account.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                | Target Datatype |
| ------------------- | --------------- |
| id                  | NUMERIC         |
| sku                 | STRING          |
| hsn                 | STRING          |
| name                | STRING          |
| description         | STRING          |
| category\_code      | STRING          |
| category\_name      | STRING          |
| category\_tax\_code | STRING          |
| image               | STRING          |
| weight              | STRING          |
| size                | STRING          |
| cost\_price         | STRING          |
| mrp                 | STRING          |
| tax\_code           | STRING          |
| low\_stock          | NUMERIC         |
| ean                 | STRING          |
| upc                 | STRING          |
| isbn                | STRING          |
| created\_at         | STRING          |
| updated\_at         | STRING          |
| quantity            | NUMERIC         |
| color               | STRING          |
| brand               | STRING          |
| dimensions          | STRING          |
| status              | STRING          |
| type                | STRING          |

**Listings**

Purpose:Using this API get a JSON representation of all the product listings in your Shiprocket account i.e all the products associated to a specific channel.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                 | Target Datatype |
| -------------------- | --------------- |
| id                   | NUMERIC         |
| title                | STRING          |
| image                | STRING          |
| price                | STRING          |
| quantity             | NUMERIC         |
| sku                  | STRING          |
| channel\_sku         | STRING          |
| channel\_id          | NUMERIC         |
| channel\_name        | STRING          |
| base\_channel\_code  | STRING          |
| channel\_product\_id | STRING          |
| inventory            | NUMERIC         |
| synced\_on           | STRING          |
| product              | RECORD          |
| category\_name       | STRING          |

**ChannelDetails**

Purpose:This API shows a list of all the channels that have already been integrated in your Shiprocket account.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                    | Target Datatype |
| ----------------------- | --------------- |
| id                      | NUMERIC         |
| name                    | STRING          |
| status                  | STRING          |
| connection\_response    | STRING          |
| channel\_updated\_at    | STRING          |
| status\_code            | NUMERIC         |
| settings                | RECORD          |
| auth                    | STRING          |
| connection              | NUMERIC         |
| orders\_sync            | NUMERIC         |
| inventory\_sync         | NUMERIC         |
| catalog\_sync           | STRING          |
| orders\_synced\_on      | STRING          |
| inventory\_synced\_on   | STRING          |
| base\_channel\_code     | STRING          |
| base\_channel           | RECORD          |
| catalog\_synced\_on     | STRING          |
| order\_status\_mapper   | STRING          |
| payment\_status\_mapper | STRING          |
| brand\_name             | STRING          |
| brand\_logo             | STRING          |

**InventoryDetails**

Purpose:This API can be used to check the inventory details of a product sku. There are no required parameters for this API but further parameters can be defined to sort and filter the data.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name                | Target Datatype |
| ------------------- | --------------- |
| id                  | NUMERIC         |
| sku                 | STRING          |
| category\_name      | STRING          |
| is\_combo           | NUMERIC         |
| name                | STRING          |
| type                | STRING          |
| color               | STRING          |
| brand               | STRING          |
| total\_quantity     | NUMERIC         |
| available\_quantity | NUMERIC         |
| blocked\_quantity   | NUMERIC         |
| updated\_on         | STRING          |

**CountryCodes**

Purpose:Shows the list of all the countries which are present in the Shiprocket database along with the respective country ids ISO 2 and ISO 3 codes. There are a total of 44 available countries in the database. You can use these codes to check the serviceability and use them in your own dropdown menu.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name               | Target Datatype |
| ------------------ | --------------- |
| id                 | NUMERIC         |
| name               | STRING          |
| iso\_code\_2       | STRING          |
| iso\_code\_3       | STRING          |
| isd\_code          | STRING          |
| address\_format    | STRING          |
| postcode\_required | NUMERIC         |
| status             | NUMERIC         |

**DiscrepancyData**

Purpose:Use this API to get the account statement details of your Shiprocket account. No parameters are required to access this API.

Source API Documentation  <https://apidocs.shiprocket.in/?version=latest#7805703f-4750-4f1e-9c59-f745853c9937>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name              | Target Datatype |
| ----------------- | --------------- |
| status            | NUMERIC         |
| data              | STRING          |
| upper\_fold\_text | STRING          |
| lower\_fild\_text | STRING          |