SmartShipAPIDocumentationV1 21

SMARTSHIP FIRST-UP INTEGRATION APIs 3
1) Login Token API: 4

2) Hub Registration API 5
3) One Step Order Registration API 7
4) Order Registration API (Background) 10
5) Get Order Details API 18
6) Create Manifest API 25
SMARTSHIP UTILITY APIs 27

1) Get Hub Details API 27
2) Update Hub Details API 30
3) Delete Hub API 32
4) Order Shipping Label API 34
5) Generate Manifest PDF API 35
6) Cancel Order API 36
7) Hub Serviceability API 37
8) Hub Serviceable Pin Codes API 40
9) Combined Manifest PDF for Already Manifested Orders 42
SMARTSHIP TRACKING APIs 44

1) Track Smartship Order API 44
2
Smartship uses token authentication mechanism for all its APIs. There are primarily two
types of tokens that are generated by the smartship system.
a) Access Token
b) Refresh Token
To access any smartship API, generating access token is the prerequisite. To get the
access token, use LoginToken API.
SMARTSHIP FIRST-UP INTEGRATION APIs

Points to consider:
● Please use the below listed APIs in their specified order to integrate with Smartship
system.
API TEST CREDENTIALS*
{
"username":"[email protected]",
"password":"e10adc3949ba59abbe56e057f20f883e",
"client_id":"1ZT6T60OPZ6LGOHOS99IV0ES5UA4",
"client_secret":"!K3V@Y_7LSD(MUG44ZG4ZTJLZ7FE8)_XI2*_D^5QL9MYGT",
"grant_type":"password"
}
3
* Replace these test credentials with your live account credentials (found in the API credentials section
of My Profile tab on smartship.in as shown in the above screenshot )to start punching live orders.
1) Login Token API:
URL: http://oauth.smartship.in/loginToken.php
Header:
Content-Type: application/json
Method:
POST
Request (Json):
{
"username": "<Your email address>",
"password": "<MD5 of your account password>" ,
"client_id": "<Shared client Id>",
"client_secret": "<Shared client secret>" ,
"grant_type": "password" // Constant String
}
Successful Response (Json):

{
"access_token": "73d37b7361b568249b9b26d5746e722c3e60", / / Sample access token
"expires_in": 3600,
"token_type": "Bearer",
"scope": null,
"refresh_token": "dfaa70a0703b2a1553a49a355edf28d5b0", // Sample refresh token
}
Failure (Json):
{
"error": "invalid_grant",
"error_description": "Invalid username and password combination"
}
Points to consider:
● Access Token is valid for 1 Hour Only. Access token can be regenerated (after 1
hour expiration) using refresh token API. New access token will again be valid for 1
HOUR.
4
● Validity of Refresh Token is for 15 Days. Once refresh token expires , new login /
access and refresh token can be generated using loginToken API.
Refresh Token API:
URL: http://oauth.smartship.in/refreshToken.php
Header:
Method:
POST
Request (Json):
{
“refresh_token”: “<Shared refresh token from loginToken API>” ,
“client_id”: “<Your client Id>”,
“client_secret”: “<Your client secret>” ,
“grant_type”: “refresh_token” // Constant String
}
Successful Response (Json):

{
“access_token”: “73d37b7361b568249b9b26d5746e722c3e60”, // Sample token
“expires_in”: 3600,
“token_type”: “Bearer”,
“scope”: null,
“refresh_token”: “dfaa70a0703b2a1553a49a355edf28d5b0”, // Sample refresh
}
2) Hub Registration API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/hubRegistration
Header:
Authorization: Bearer XXXXXX
Method:
POST
Request (Json):
{
"hub_details": {
5
"hub_name": "Delhi Warehouse",
"pincode": "122001",
"city": "Gurgaon",
"state": "Harayana",
"address1": "G-167,Sector 40",
"address2": "First Floor, Near Police Station ",
"hub_phone": "9999613323"
"delivery_type_id": 2
}
}
Request Field Details:
Field Name Data Type Description Is Mandatory?
hub_name Varchar Name of your hub Yes
pincode Numeric Pincode of the hub Yes
city Varchar City name Yes
state Varchar State name Yes
address1 Varchar Address line 1 Yes
address2 Varchar Address line 2 Yes
hub_phone Numeric Valid 10 digit phone Yes

number
delivery_type_id Numeric (Can have Id describing hub’s No (Takes default

values as 1/2/3 only) service type value as 1 i.e
Express)
1 - Express
2 - Economy
3 - Bulk
Successful Case:
Response (Json):
{
"status": 1,
"code": 200,
"message": "success",
"data": {
"info": "Hub registered successfully",
"hub_id": 1239
},
6
"extra": null
}
Failed Case:
Response(Json):
{
"status": 0,
"code": 200,
"message": "OK",
"data": {
"message": {
"info": "Hub registration failed",
"validation_error": ["invalid pincode"]
}
},
"extra": null
}
3) One Step Order Registration API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/orderRegistrationOneStep
Header:
Method:
POST
Request (Json):
{
"orders": [
{
"client_order_reference_id": "test_rf_4",
"order_collectable_amount": "0.00",
"total_order_value": "2.00",
"payment_type": "Prepaid",
"package_order_weight": "1.00",
"package_order_length": "20.000",
"package_order_height": "20.000",
"package_order_width": "20.000",
"shipper_hub_id": "1436",
7
"shipper_gst_no": "342323",
"order_invoice_date": "2018-05-05 13:35:10",
"order_invoice_number": "NWB-WalkIn-000043",
"order_ewaybill_number": "",
"order_ewaybill_expiry_date": "",
"product_details": [
{
"product_name": "Natrol Arginine testing details and aura of natrol arginine",
"product_category": "Natrol Arginine testing details and aura of natrol arginine",
"product_hsn_code": "FLOUR, MEAL AND POWDER OF THE DRIED
LEGUMINOUS VEGETABLES OF HEADING 0713, OF SAGO OR OF ROOTS OR TU",
"product_quantity": "2.000",
"product_invoice_value": "123",
"product_taxable_value": "1.00",
"product_sgst_amount": "2",
"product_cgst_amount": "2",
"product_gst_tax_rate": "2",
"product_cgst_tax_rate": "2",
"product_sgst_tax_rate": "2"
}
],
"consignee_details": {
"consignee_name": "NWM Nykaa Warehouse Mumbai",
"consignee_phone": "7696273007",
"consignee_email": "[email protected]",
"consignee_complete_address": "Mumbai,3211234 Mumbai,Maharashtra
Mumbai,3211234 Mumbai,Maharashtra null Mumbai Maharashtra india",
"consignee_pincode": "122001"
}
}
],
"request_info": {
"client_id": "47AL34QKCL60AT5WCZRM83S4PUUECF",
"run_type": "create"
}
}
Response(Json):
{
"status": 1,
"code": 200,
"data": {
"total_records": 1,
"total_success_orders": 1,
"request_id": 1988,
8
"total_eliminated_orders": 0,
"success_order_details": {
"orders": [
{
"index": 0,
"client_order_reference_id": "test_rf_4",
"request_order_id": 4993,
"message": "Successfully Punched",
"transition": {
"status": true
},
"dss_carrier_allocation": true,
"carrier_name": "Xpressbees-Surface",
"awb_assigned": true,
"awb_number": "1386418030153",
"code": 4
}
],
"shipping_info": {
"label_url":
"http://admin.smartship.in/images/excel_upload/shipping_label/14-08-2018/shipping-label-cb
e11d722ee3f772557e80f13f197e56.pdf"
}
},
"errors": null
},
"extra": null
}
Status Codes & Order States:
Status Code Order States
Code 1 Order Registered
Code 2 Order Created Successfully
Code 3 Dss Carrier Assigned
Code 4 Awb no assigned
Points To Consider:
● One Step Order Registration API gives leverage to our customers not only to
successfully register their respective orders into smartship system , but also takes
care of carrier allocation and tracking (awb) number assignment etc. without much
ado.
9
● There is though a limit to One Step Order Registration API of 10 orders at one go.
● To bypass that limit, customers can use our Order Registration API (below) and
provide any number of orders to process.
● Our Order Registration API (below) runs on batch system, where order registration
along with series of other tasks (starting from carrier allocation to Awb assignment)
runs as background job to process one complete batch.
4) Order Registration API (Background)
URL: http://api.smartship.in/v2/app/Fulfillmentservice/orderRegistration
Header:
Method:
POST
Request (Json):
{
"request_info": {
"ip_address": "14.142.227.166",
"run_type": "create",
"browser_name": "Mozilla",
"location": "Delhi"
},
"orders": [
{
"client_order_reference_id": "OC49834",
"order_collectable_amount": "100",
"total_order_value": "120",
"payment_type": "COD",
"package_order_weight": "217",
"package_order_length": "59",
"package_order_height": "39",
"package_order_width": "29",
"shipper_gst_no": "29ABCDE1234F2Z5",
"order_invoice_date": "09-08-2018",
"order_invoice_number": "invoice123",
"order_ewaybill_number": "abde12398376ds",
"order_ewaybill_expiry_date": "2018-02-13",
{
10
"client_product_reference_id": "P120",
"product_name": "WD SSD Storage GB 9",
"product_category": "computer",
"product_hsn_code": "8471",
"product_quantity": "1",
"product_taxable_value": "100",
"product_igst_amount": "0",
"product_ugst_amount": "0",
"product_sgst_tax_rate": "5",
"product_igst_tax_rate": "0",
"product_ugst_tax_rate": "0"
},
{
"product_name": "WD SSD Storage GB 10",
"product_category": "computer",
"product_taxable_value": "100",
"product_igst_amount": "0",
"product_ugst_amount": "0",
"product_sgst_tax_rate": "5",
"product_igst_tax_rate": "0",
"product_ugst_tax_rate": "0"
}
],
"consignee_name": "Ravish Mishra",
"consignee_complete_address": "H.No. Sector 59",
"consignee_pincode": "122003"
}
}
]
}
11
Response(Json):
{
"status": 1,
"code": 200,
"data": {
"total_records": 1,
"total_success_orders": 1,
"total_eliminated_orders": 0,
"success_order_details": [
{
"index": 0,
"client_order_reference_id": "OC49834",
"request_order_id": 316,
"message": "Successfully Punched"
}
],
"errors": null
},
"extra": null
}
Field Name Data Description Mandatory

Type
request_info Json json object containing request Yes

information
request_info - “ip_address” Varchar IP address from where request No

is being created
request_info - “run_type” Varchar Value can be either “validate” Yes

or “create” if run-type =
“create” then only orders will
be punched
otherwise get validated
request_info - Varchar Browser Name No

“browser_name”
request_info - “location” Varchar Location of request No
Orders Array Array containing information Yes

(Json about each order
12
Objects)
orders - Varchar Client’s order reference Yes

“client_order_reference_id” identifier
orders - Numeric Amount to be collected from Yes

“order_collectable_amount” customer. Non-zero in case of
COD order.
orders - “total_order_value” Numeric Total order value Yes
orders - “payment_type” Varchar Payment mode. Can only be Yes

“cod” or “prepaid”
orders - Numeric Weight or order in grams Yes

“package_order_weight”
orders - Numeric Length of package in Yes

“package_order_length” centimetres.
orders - Numeric Height of package in Yes

“package_order_height” centimetres.
orders - Numeric Width of package in Yes

“package_order_width” centimetres.
orders - “shipper_hub_id” Numeric Registered hub_id of client Yes

from whom order needs to be
picked
orders - “shipper_gst_no” Varchar Gst no. Of shipper Yes
orders - “order_invoice_date” Varchar Date when order invoice is No

generated. Date Format:
“dd-mm-yyyy”
orders - Varchar Order invoice number No

“order_invoice_number”
orders - Varchar If total order value > 50K then No

“order_ewaybill_number” order_ewaybil_number is
mandatory
orders - Varchar If total order value > 50K then No

“order_ewaybill_expiry_date” order_ewaybill_expiry_date is
mandatory
product_details Array
(Json
Objects)
product_details - Varchar Client’s product id for No

“client_product_reference_id” reference
13
product_details - Varchar Name of product Yes
“product_name”
product_details - Varchar Category of product No

“product_category”
product_details - Varchar Hsn code of product No

“product_hsn_code”
* mandatory
incase of gst
clients
product_details - Numeric Quantity of product Yes

“product_quantity”
product_details - Numeric Invoice value of product No

“product_invoice_value”
product_details - Numeric Product GST tax rate No

“product_gst_tax_rate”
* mandatory
incase of gst
clients
consignee_details Json Consignee details Yes

Object
consignee_details - Varchar Name of customer Yes

“consignee_name”
consignee_details - Varchar Phone number of customer Yes

“consignee_phone”
consignee_details - Varchar Email id of customer Yes

“consignee_email”
consignee_details - Varchar Address of customer Yes

“consignee_complete_addres
s”
consignee_details - Numeric Pincode of customer Yes

“consignee_pincode” (destination pincode)
“product_taxable_value” Numeric Selling price per quantity on Yes

which GST tax is applicable
“product_sgst_amount” Numeric If the sgst/ugst tax is Yes

applicable, then both fields If the sgst/ugst
sgst and cgst are required. tax is
Else, Igst is mandatory. applicable,
then both fields
Note:* Please pass blank in sgst and cgst
other gst fields. Do not pass are required.
14
‘0’ as 0 is tax applicable on Else, Igst is
some product categories mandatory
“product_cgst_amount” Numeric If the sgst/ugst tax is Yes. If the

applicable, then both fields sgst/ugst tax is
sgst and cgst are required. applicable,
Else, Igst is mandatory. then both fields
Note:* Please pass blank in sgst and cgst
other gst fields. Do not pass are required.
‘0’ as 0 is tax applicable on Else, Igst is
some product categories mandatory.
“product_igst_amount” Numeric If the sgst/ugst tax is Yes. If the

sgst / ugst and cgst are applicable,
required. Else, Igst is then both fields
mandatory. sgst/ugst and
Note:*Please pass blank in cgst are
other gst fields. Do not pass required. Else,
‘0’ as 0 is tax applicable on Igst is
“product_ugst_amount” Numeric If the sgst/ugst tax is Yes. If the

sgst/ugst and cgst are applicable,
required. Else, Igst is then both fields
Note:* Please pass blank in cgst are
some product categories. mandatory.
“product_cgst_rate” Numeric If the sgst/ugst tax is Yes. If the sgst

applicable, then both fields tax is
sgst/ugst and cgst rate are applicable,
required. Else, Igst rate is then both fields
mandatory. sgst / ugst and
Note:* Please pass blank in cgst are
some product categories. mandatory.
“product_sgst_rate” Numeric If the sgst/ugst tax is Yes. If the

mandatory. ugst/sgst and
Note:* Please pass blank in cgst rate are
‘0’ as 0 is tax applicable on Igst rate is
15
“product_igst_rate” Numeric If the sgst/ugst tax is Yes. If the
“product_ugst_rate” Numeric If the sgst/ugst tax is Yes. If the

cgst/ugst and cgst rate are applicable,
Response Field Details:
Field Description
status Shows response status. 1 for success, 0 for failure
code Status Code
message Shows overall response message. Success if request

processed successfully else failure
data Contains information about parsed request. Such as

how may orders are there in request, how many of
them successfully punched & how many eliminated.
Also details of successfully punched orders and
eliminated orders
“data - total_records” Count of orders present in request
“data - total_success_orders” Count of orders successfully punched
“data - total_eliminated_orders” Count of orders eliminated
success_order_details Array containing details of successfully punched orders
“success_order_details - Index” Index of orders array sent in request
“success_order_details - order_id provided by client

client_order_reference_id”
16
“success_order_details - Smartship request order_id
request_order_id”
“success_order_details - Message regarding punched order.

message”
errors Array of errors for orders which got eliminated. Null if

no errors found
“errors - Array containing information of orders in which some

mandatory_fields_missing” mandatory fields are missing
“errors - missing_field” Name of the mandatory field which is missing
“errors - Array containing information of orders in which value

mandatory_field_value_missing” of mandatory field is missing
Field Name of field
Value Empty string showing that value of a mandatory field is

missing
data_discrepancy Array containing validation errors of eliminated orders
errors Array containing error information of a particular order
extra Array of extra information. Null if no extra info present
5) Get Order Details API

URL: http://api.smartship.in/v2/app/Fulfillmentservice/orderDetails
Header:
Method:
POST
Request (Json):
{
"filters": {
"filter_type": {
"and": {
17
"status": {
"status_code": "1,2,3,4,5,6,7,8",
"check_type": "Y"
},
"request_order_id": "166,167,168,169",
"client_order_reference_id": "SHP06,SHP07,SHP08,SHP09",
"payment_type": "cod",
"created_date": {
"from": "2018-03-27",
"to": "2018-03-28"
},
"updated_date": {
"from": "2018-03-27",
"to": "2018-03-28"
}
}
}
},
"sort_by": {
"fields": "request_order_id",
"type": "desc"
},
"limit": {
"offset": 0,
"limit": 1
}
}
Name Type Description Is Mandatory?
status_code Varchar Contains smartship No

status codes comma
separated
check_type Varchar Contains character No

Y or N (Y for in
status) and (N for
not in status)
request_order_id Varchar Contains comma No

separated request
order ids
client_order_referen Varchar Contains comma No

ce_id separated client
order reference id
18
payment_type Varchar Contains payment No
type(cod or prepaid)
created_date Json Object from: starting date, No

to: ending date
Date Format:
“yyyy-mm-dd”
updated_date Json Object from: starting date, No

to: ending date
Date Format:
“yyyy-mm-dd”
sort_by Json Object fields: name of No

fields to sort order
details,
type: asc or desc
limit Json Object offset: value of No

offset,
limit: value of total
number of records
Response(Json):
{
"status": 1,
"code": 200,
"data": {
"summary": {
"start_time": "11-05-2018 13:15:13",
"end_time": "11-05-2018 13:15:14",
"time_taken": 0.40403199195862,
"total_records": 56,
"confirmed_orders": 47,
"pending_orders": 5
},
"orders_details": {
"121": {
"order_details": {
"request_order_id": "121",
"request_id": "51",
19
"client_id": "client_id_of_3pl_shared_by_faas",
"client_order_reference_id": "OD00081",
"client_order_reference_type": "client",
"order_collectable_amount": "0",
"total_order_value": "499",
"payment_type": "prepaid",
"package_order_weight": "500",
"package_order_length": "40",
"package_order_width": "10",
"package_order_height": "20",
"status": "9",
"shipper_gst_no": "29ABCDE1234F2Z5",
"hash": "82297e9727b6bcfe026c12c77418f5bd",
"order_effective_weight": "1600",
"order_invoice_date": "0000-00-00 00:00:00",
"order_invoice_number": null,
"order_ewaybill_number": null,
"order_ewaybill_expiry_date": "0000-00-00 00:00:00",
"added_on": "2018-03-29 12:41:17",
"Updated_on": "2018-04-17 13:49:56",
"status_description": "Non Serviceable"
},
"hub_details": {
"shipper_name": "faas_test_shiiper",
"shipper_email": "[email protected]",
"shipper_address": "teast_faas_adderss",
"shipper_phone": "9876543210",
"shipper_pincode": "122001",
"shipper_city": "Patna",
"shipper_state": "Bihar",
"shipper_state_code": "BH"
},
"consignee_id": "124",
"consignee_name": "Anil01",
"consignee_address": "Sector 40",
"consignee_pincode": "122001",
"consignee_city": "Gurgaon",
"consignee_state": "Haryana",
"consignee_state_code": "HR",
"consignee_country_code": "IN"
},
20
{
"order_product_id": null,
"client_product_reference_type": "client",
"product_name": "Round Neck Dark Blue T-Shirt Size 01",
"product_category": "fashion",
"product_price": "0",
"product_discount": null,
"product_invoice_value": null,
"product_gst_tax_rate": null,
"added_on": "2018-03-29 12:41:17",
"updated_on": "0000-00-00 00:00:00",
"product_meta_id": null,
"key": null,
"value": null
},
{
"order_product_id": null,
"client_product_reference_type": "client",
"product_name": "Round Neck Dark Blue T-Shirt Size 02",
"product_category": "fashion",
"product_price": "0",
"product_discount": null,
"product_invoice_value": null,
"product_gst_tax_rate": null,
"added_on": "2018-03-29 12:41:17",
"updated_on": "2018-05-11 12:54:20",
"product_meta_id": null,
"key": null,
"value": null
}
],
"order_meta_details": {
"dss_carrier_id": {
"order_meta_id": "338711",
"dss_carrier_id": "2"
},
"carrier_name": {
21
"carrier_name": "Xpressbees"
},
"awb_no": {
"awb_no": "1386418000163"
}
}
}
}
},
"extra": null
}
Field Name Description
start_time starting time of the api
end_time ending time of the api
time_taken time taken by api in seconds
total_records Count of records without limit used(satisfied by all

conditions)
confirmed_orders Count of orders that are confirmed
pending_orders Count of orders that are in pending status
order_details Json object (request_order_ids & order_details in key -

value pair respectively)
request_order_id request_order_id of order
request_id request_id of order
client_order_reference_id client order reference id of order
client_order_reference_type client order reference type of order
order_collectable_amount total amount to be collected
total_order_value total amount of order
payment_type cod or prepaid
package_order_weight package weight
package_order_length package length
22
package_order_width package width
package_order_height package height
status Smartship status of order
shipper_gst_no shipper’s gst number
Hash Unused
order_effective_weight effective weight of order
order_invoice_date invoice date of order
order_invoice_number invoice number of order
order_ewaybill_number ewaybill number of order
order_ewaybill_expiry_date expiry date of ewaybill number
added_on order created on date
updated_on updated date
status_description Description of SmartShip order status of order
shipper_hub_id shipper’s hub id
shipper_name shipper’s name
shipper_email shipper’s email id
shipper_address shipper’s address
shipper_phone shipper’s contact number
shipper_pincode shipper’s pincode
shipper_city shipper’s city name
shipper_state shipper’s state name
shipper_state_code shipper’s state code
consignee_id consignee’s id
consignee_name consignee’s name
consignee_address consignee’s address
consignee_pincode consignee’s pincode
consignee_email consignee’s email id
consignee_phone consignee’s contact number
23
consignee_city consignee’s city name
consignee_state consignee’s state name
consignee_state_code consignee’s state code
consignee_country_code consignee’s country code
order_product_id Product’s ID within order
product_name Name of product within order
product_category Product’s category within order
product_hsn_code Product’s hsn code
product_price Price of product
product_discount Discount of product (if any)
product_quantity Quantity of product
product_invoice_value invoice value of product
product_gst_tax_rate gst tax rate of product
order_meta_details meta details of order
carrier_name Carrier Name
awb_no Tracking number of order
dss_carrier_id Carrier Id
Points To Consider:
● Use orderDetails API (above) to track the exact / true status of any order. You can
pass total order count in <limit> field to fetch the details.
6) Create Manifest API
URL:
http://api.smartship.in/v2/app/Fulfillmentservice/createManifest
Header:
Method:
POST
24
Request (Json):
{
"client_order_reference_ids": [
"test123"
]
}
Field Name Type Description Is Mandatory?
client_order_reference_ids Array Client order No

reference ids of
Orders
Response(Json):
{
"status": 1,
"code": 200,
"data": {
"summary": {
"total_orders_count": 2,
"total_success_orders_count": 2,
"manifest_ids": [
942,
943
],
"start_time": "07-06-2018 12:19:43",
"end_time": "07-06-2018 12:19:44",
"time_taken": 1.5540709495544
},
"errors": [],
"manifest_details": {
"hub_id": {
"1234": {
"carrier_ids": {
"10": {
"order_id": [
300
],
"manifest_id": 942,
"carrier_name": "Aramex",
25
"courier_manifest_pdf_url":
"http://admin.smartship.in/images/excel_upload/manifest_pdf/07-06-2018/Courier-Manifest-2
018-06-07-1528354183.pdf"
},
"14": {
"order_id": [
301
],
"manifest_id": 943,
"carrier_name": "Delhivery",
"courier_manifest_pdf_url": "pdf_actual_url"
}
}
}
}
}
},
"extra": null
}
Field Name Type Description
summary Json Object Summary of response
“summary - total_orders_count” Varchar Count of total orders

processed
“summary - Varchar Count of total successfully

total_success_orders_count” manifested orders
“summary - manifest_ids” Array Generated manifest ids
“summary - start_time” Varchar Start time of api
“summary - end_time” Varchar End time of api
errors Json Object Errors with descriptions

while creating manifests
manifest_details Json Object Manifest Details
“manifest_details - hub_ids” Json Object Details of manifests hub

wise
“manifest_details - carrier_ids” Json Object Details of manifests carrier

ID wise
“manifest_details - order_id” Array Manifest Order Ids
26
“manifest_details - manifest_id” Numeric Manifest Id
“manifest_details - Varchar Url of manifest_pdf

carrier_manifest_pdf_url”
SMARTSHIP UTILITY APIs

1) Get Hub Details API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/getHubDetail
Header:
Method:
POST
Successful Cases:
a) Request (Json):
{
"hub_ids": [
1221,
1234
]
}
Response (Json):
{
"status": 1,
"code": 200,
"data": {
"valid_hubs": {
"1355": {
"hub_phone": "9999613323",
"pincode": "122001",
"city": "Gurgaon",
"state": "Haryana",
"address1": "G-167,Sector 40",
27
"address2": "First Floor, Near Police Station "
}
},
"invalid_hub_ids": []
},
"extra": null
}
2) Request(Json):
{
"hub_ids": ""
}
Response(Json):
{
"status": 1,
"code": 200,
"data": {
"valid_hubs": {
"1234": {
"hub_phone": "9999613323",
"pincode": "122001",
"city": "Patna",
"state": "Bihar",
"address1": "teast_faas_adderss",
"address2": null
},
"1235": {
"hub_name": "ABC Warehouse",
"hub_phone": "9999713323",
"pincode": "122001",
"city": "Gurgaon",
"state": "Haryana",
"address1": "Plot-80,sector-44",
"address2": "Plot-112,sector-44"
}
},
"invalid_hub_ids": []
},
"extra": null
}
28
Failed Case:
Request(Json):
{
"hub_ids": [
1923,
1253
]
}
Response(Json):
{
"status": 0,
"code": 200,
"message": "OK",
"data": {
"message": {
"valid_hubs": [],
"invalid_hub_ids": [1923, 1253],
"info": "hub_details not found"
}
},
"extra": null
}
2) Update Hub Details API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/updateHubDetails
Header:
Method:
POST
Successful Case:
Request (Json):
{
"hub_id": "1234",
29
"hub_phone": "9999613323",
"pincode": "122001",
"city": "Gurgaon",
"state": "Haryana",
"address1": "ad1",
"address2": "ad2"
}
Response (Json):
{
"status": 1,
"code": 200,
"data": {
"info": "hub data updated successfully"
},
"extra": null
}
Failed Cases:
1) Request(Json):
{
"hub_id": "1354",
"hub_phone": "9999613323",
"pincode": " 226004",
"city": "Lucknow",
"state": "Uttar Pradesh",
"address1": "ad1",
"address2": "ad2"
}
Response(Json):
{
"status": 0,
"code": 200,
"message": "OK",
"data": {
"message": {
30
"info": "invalid hub_id"
}
},
"extra": null
}
2) Request(Json):
{
"hub_id": "1236",
"hub_phone": "9999613323",
"pincode": " 226004",
"city": "Lucknow",
"state": "",
"address1": "ad1",
"address2": "ad2"
}
Response(Json):
{
"status": 200,
"code": 41000,
"message": "invalid_inputs",
"data": null,
"extra": null
}
3) Request(Json):
{
"hub_id": "1235",
"hub_phone": "9999613323",
"pincode": " 22600",
"city": "Lucknow",
"state": "uttar pradesh",
"address1": "ad1",
"address2": "ad2"
}
Response(Json):
{
"status": 0,
"code": 200,
"message": "OK",
"data": {
"message": {
31
"info": "Hub data invalid",
"validation_error": ["invalid pincode"]
}
},
"extra": null
}
3) Delete Hub API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/deleteHub
Header:
Method:
POST
Successful Case:
Request(Json):
{
"hub_ids": [
1237
]
}
Response(Json):
{
"status": 1,
"code": 200,
"data": {
"info": "hub deleted successfully"
},
"extra": null
}
Failed Case:
32
Request(Json):
{
"hub_ids": [
1236,
1221
]
}
Response(Json):
{
"status": 0,
"code": 200,
"message": "OK",
"data": {
"message": {
"invalid_hubs": [1221],
"info": "invalid hub passed"
}
},
"extra": null
}
4) Order Shipping Label API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/getShippingLabels
Header:
Method:
POST
Request (Json):
{
"request_order_id": "184,183",
"client_order_ref_id": "od02"
}
33
request_order_id Varchar Comma Separated No
SmartShip Order Id
client_order_ref_id Varchar Comma Separated No

Client’s Reference
Order Id
Note: One of the above field is mandatory
Response (Json):
{
"status": 1,
"code": 200,
"data": {
"error": {
"invalid_request_order_ids": []
},
"url":
"http://admin.smartship.in/images/excel_upload/shipping_label/16-04-2018/shipping-label-f0
d9bb91b344618ab9fcf740c0e62526.pdf"
},
"extra": null
}
5) Generate Manifest PDF API
URL: http://api.smartship.in/v1/Faascreatemanifestpdf
Header:
Method:
POST
Request (Json):
{
"manifest_ids": [
111694
]
}
Response(Json):
{
34
"status": 1,
"code": 200,
"data": {
"manifest_pdf_url": {
"111694":
"http://admin.smartship.in/images/excel_upload/manifest_pdf/18-01-2019/Courier-Manifest-2
019-01-18-111694.pdf"
},
"error": {
"invalid_manifest_ids": []
},
"summary": {
"total_manifests_count": 1,
"total_valid_manifests_count": 1,
"failed_manifests_count": 0,
"start_time": "18-01-2019 17:14:54",
"end_time": "18-01-2019 17:14:55",
"time_taken": 0.5546350479126
}
},
"extra": null
}
6) Cancel Order API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/orderCancellation
Header:
Method:
POST
Request (Json):
{
"request_info": {
"ip_address": "14.142.227.166",
"browser_name": "Mozilla",
"location": "Delhi"
},
"orders": {
"client_order_reference_ids": [
35
"OD00200",
"OD00201"
],
"request_order_ids": []
}
}
ip_address Varchar IP address No
browser_name Varchar Name of browser No
Location Varchar Location Name No
client_order_reference_ids Varchar Comma separated

client order Provide either
reference ids client_order_referen
ce_ids or
request_order_ids Varchar Comma separated request_order_ids
SmartShip request
order ids
Response(Json):
{

"status":1,
"code":200,
"message":"success",
"data":{
"order_cancellation_details":{
"failure":{
"
OD00200":{
"message":"Change Order Status Priviledge Denied"
}
},
"successful":[
"
OD00201"
]
}
},
"extra":null
}
36
failure message (
Change Cancellation is not allowed in this order status
Order Status Priviledge
Denied
)
successful Successfully Cancelled orders
extra Any extra information
7) Hub Serviceability API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/ServiceabilityHubWise
Header:
Method:
POST
Request (Json):
1. For forward order use field “destination_pincode

”
{
"order_info":{
"hub_ids":[
1353
],
"destination_pincode":122001,
"order_weight":500
},
"request_info":{
"extra_info":true,
"cost_info":true
}
}
2. For return order use field “source_pincode

”
{
"order_info":{
"hub_ids":[
1353
37
],
"source_pincode":122001,
"order_weight":500
},
"request_info":{
"extra_info":false,
"cost_info":true
}
}
hub_ids Numeric Comma separated Yes

hub ids
source_pincode Numeric Pincode to check for Yes (In case

serviceability checking
serviceability for
return order)
destination_pincode Numeric Pincode to check for Yes (In case

serviceability checking
serviceability for
forward order)
extra_info Boolean If detailed info for No

carriers required
send true
cost_info Boolean If detailed info for No

cost required send
true
Response(Json):
{
"status":1,
"code":200,
"data":{
"serviceability_status":true,
"hub_serviceability":{
"1353":{
"pickup_cod_serviceability_status":true,
"pickup_prepaid_serviceability_status":true,
"pickup_serviceability_status":true,
"delivery_cod_serviceability_status":true,
38
"delivery_prepaid_serviceability_status":true,
"delivery_serviceability_status":true,
"cod_serviceability_status":true,
"prepaid_serviceability_status":true,
"serviceability_status":true,
"cost_info":{
"cost":"21.00",
"tat":"3.00",
"rto_cost":"21.00",
"region_name":"Within City"
},
"hub_id":1353
}
},
"time_taken":0.083376169204712,
"request_id":"1pUfqG"
},
"extra":null
}
hub_serviceability Hub wise service serviceability status
cost_info Cost estimation (Returned when cost_info flag set as

true)
pickup_service_carriers Extra information regarding carriers (Returned when

delivery_service_carriers extra_infoflag set as true)
disable_carriers_on_hub
8) Hub Serviceable Pin Codes API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/HubServiceablePincodes
Header:
Method:
POST
Request (Json):
39
{
"request_info":{
"format":"csv"
},
"hub_info":{
"start":10,
"limit":3
"hub_id":1353
}
}
format Varchar “csv” - to get csv No

download link
null - to fetch result
as JSON body
hub_id Numeric Hub id for which list Yes

of serviceable pin
codes required
start Numeric Defines starting No

point for the records
to be fetched
limit Numeric Defines no of No

records to be
fetched
Response(Json):
1. When format is “csv”

{
"status":1,
"code":200,
"data":{
"serviceable_pincodes":{
"hub_serviceable_pincodes":{
40

"data_url":" http://smartship.in/images/excel_upload/mis_data/H
ub-1353-12-06-2020.csv ",
"file_size":146
}
},
"start":10,
"limit":3,
"time_taken":4.2403399944305
},
"extra":null
}

2. When format not set / null

{
"status":1,
"code":200,
"data":{
"serviceable_pincodes":[
{
"destination_pincode":"110011",
"cod_carriers":"1",
"prepaid_carriers":"1",
"region_id":"1",
},
{
"cod_carriers":"1",
"region_id":"1",
},
{
"cod_carriers":"1",
"region_id":"1",
}
],
"start":10,
"limit":3,
41
"time_taken":4.2417559623718
},
"extra":null
}

9) Combined Manifest PDF for Already Manifested Orders
URL: http://api.smartship.in/v2/app/Fulfillmentservice/getOrdersManifestPdf
Header:
Method:
POST
Request (Json):
{
"client_order_reference_ids":[
"
OD00200"
]
}
client_order_reference_ids Varchar Comma separated Yes

client order
reference ids
* Orders should
already be in
manifested status
Successful Response( JSON ):

{
"status":1,
"code":200,
42
"data":{
"summary":[

],
"manifest_details":{

"manifest_url":"
https://smartship.in/images/excel_upload/manifest_pd
f/manifest-details-08f5c17e1bd1d71b16cdbdcec45f8908-12-06-2020.pdf
",
"file_size":8029
}
},
"extra":null
}

Failure Response (JSON)

{
"status":1,
"code":200,
"data":{
"manifest_details":false,
"error":"No vaid order found"
},
"extra":null
}

failure message (
Change Cancellation is not allowed in this order status
Order Status Priviledge
Denied
)
successful Successfully Cancelled orders
extra Any extra information
43
SMARTSHIP TRACKING APIs
1) Track Smartship Order API
URL:
http://api.smartship.in/v1/Trackorder?request_order_ids=130
OR
http://api.smartship.in/v1/Trackorder?order_reference_ids=OD00204
Header:
Method:
GET
Response (Json):
{
"status": 1,
"code": 200,
"data": {
"scans": {
"130": [
{
"order_reference_id": "OD00204",
"tracking_number": "EQ235340552IN",
"date_time": "03-04-2018 12:08:41",
"location": "Panipat_PC (Haryana)",
"action": "Shipped to RTO",
"status_code": "",
"status_description": ""
},
{
"date_time": "03-04-2018 12:08:40",
"action": "SHipped to RTO",
44
"status_code": "",
},
{
"date_time": "03-04-2018 12:08:40",
"action": "RTO to RTO Delivered",
"status_code": "",
},
{
"date_time": "02-04-2018 12:08:40",
"location": "Delhi",
"action": "Manifested to shipped",
"status_code": "",
},
{
"date_time": "02-04-2018 12:08:40",
"action": "SHipped to RTO",
"status_code": "",
},
{
"date_time": "02-04-2018 12:08:39",
"location": "Delhi",
"action": "Manifested to shipped",
"status_code": "",
45
}
]
}
},
"extra": []
}
request_order_id SmartShip Order ID
order_reference_id Client’s reference id
tracking_number Tracking number
carrier_name Carrier Name
date_time Shipment Scan date and time
Location Shipment location
Action Description
Status Code & Description
Status Code Status Description
10 Shipped
11 Delivered
12 Delivery Attempted - Out Of Delivery Area
13 Delivery Attempted - Address Issue/Wrong Address
14 Delivery Attempted - COD Not ready
15 Delivery Attempted - Customer Not Available/Contactable
16 Delivery Attempted - Customer Refused To Accept Delivery
17 Delivery Attempted - Requested for Future Delivery
18 Return To Origin
46
19 RTO Delivered To Shipper
27 In Transit
28 RTO In Transit
47

SmartShipAPIDocumentationV1 21

Uploaded by

Copyright:

Available Formats

SmartShipAPIDocumentationV1 21

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SmartShipAPIDocumentationV1 21

Uploaded by

Copyright:

Available Formats

SMARTSHIP FIRST-UP INTEGRATION APIs 3

1) Login Token API: 4

SMARTSHIP UTILITY APIs 27

SMARTSHIP TRACKING APIs 44

SMARTSHIP FIRST-UP INTEGRATION APIs

API TEST CREDENTIALS​*

1) ​Login Token API:

Successful Response (Json):

Refresh Token API:

Successful Response (Json):

2) ​Hub Registration API

Request Field Details:

Field Name Data Type Description Is Mandatory?

hub_name Varchar Name of your hub Yes

pincode Numeric Pincode of the hub Yes

city Varchar City name Yes

state Varchar State name Yes

address1 Varchar Address line 1 Yes

address2 Varchar Address line 2 Yes

hub_phone Numeric Valid 10 digit phone Yes

delivery_type_id Numeric (Can have Id describing hub’s No (Takes default

3) ​One Step Order Registration API

Status Codes & Order States:

Status Code Order States

Code 1 Order Registered

Code 2 Order Created Successfully

Code 3 Dss Carrier Assigned

Code 4 Awb no assigned

4) ​Order Registration API (Background)

Request Field Details:

Field Name Data Description Mandatory

request_info Json json object containing request Yes

request_info - “ip_address” Varchar IP address from where request No

request_info - “run_type” Varchar Value can be either “validate” Yes

request_info - Varchar Browser Name No

request_info - “location” Varchar Location of request No

Orders Array Array containing information Yes

orders - Varchar Client’s order reference Yes

orders - Numeric Amount to be collected from Yes

orders - “total_order_value” Numeric Total order value Yes

orders - “payment_type” Varchar Payment mode. Can only be Yes

orders - Numeric Weight or order in grams Yes

orders - Numeric Length of package in Yes

orders - Numeric Height of package in Yes

orders - Numeric Width of package in Yes

orders - “shipper_hub_id” Numeric Registered hub_id of client Yes

orders - “shipper_gst_no” Varchar Gst no. Of shipper Yes

orders - “order_invoice_date” Varchar Date when order invoice is No

orders - Varchar Order invoice number No

orders - Varchar If total order value > 50K then No

orders - Varchar If total order value > 50K then No

product_details - Varchar Client’s product id for No

product_details - Varchar Category of product No

product_details - Varchar Hsn code of product No

product_details - Numeric Quantity of product Yes

product_details - Numeric Invoice value of product No

product_details - Numeric Product GST tax rate No

consignee_details Json Consignee details Yes

API TEST CREDENTIALS*

1) Login Token API:

2) Hub Registration API

3) One Step Order Registration API

4) Order Registration API (Background)

“product_cgst_amount” Numeric If the sgst/ugst tax is Yes. If the

“product_igst_amount” Numeric If the sgst/ugst tax is Yes. If the

“product_ugst_amount” Numeric If the sgst/ugst tax is Yes. If the

“product_cgst_rate” Numeric If the sgst/ugst tax is Yes. If the sgst

“product_sgst_rate” Numeric If the sgst/ugst tax is Yes. If the

“product_ugst_rate” Numeric If the sgst/ugst tax is Yes. If the

5) Get Order Details API

created_date Json Object from: starting date, No

updated_date Json Object from: starting date, No

sort_by Json Object fields: name of No

limit Json Object offset: value of No