Shiprocket
Shiprocket ETL connector for data replication
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 | Shiprocket api user email Shiprocket api user password |
Replication Type | Key Based Incremental Full Replication |
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
Signin to Daton
Select Shiprocket from Integrations page
Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later
Provide your shiprocket api user email and password to authorize Daton to periodically extract data from shiprocket.
Post successful authentication you will be prompted to choose from the list of available tables
Then select all required fields for each table
Submit the integration
Workflow
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
Users would be able to edit/pause/re-activate/delete integration anytime
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 |
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 |
Last updated