SMARTSHIP FIRST-UP INTEGRATION APIs 3

1) Login Token API: 4

2) Hub Registration API 5
3) One Step Order Registration API 6
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 33
5) Cancel Order API 35
6) Hub Serviceability API 36
7) Hub Serviceable PinCodes API 39
8) Combined Manifest PDF for Already Manifested Orders 42
9) Carrier Serviceable Pincodes API 45
10) Order Reattempt API 46

SMARTSHIP TRACKING APIs 48

1) Track Smartship Order API 48

SMARTSHIP RATE CALCULATOR API 53-54

SMARTSHIP CALLBACK FUNCTIONALITY 55

Smartship uses token authentication mechanism for all its APIs.

To access any smartship API, generating access token is the prerequisite.

To get the access token, use LoginTokenAPI.

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 int the above screenshot) to
start punching live orders.

1) Login Token API:

URL:https://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.

4
2) Hub Registration API

URL:https://api.smartship.in/v2/app/Fulfillmentservice/hubRegistration

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
{
"hub_details":{
"hub_name":"Delhi Warehouse",
"pincode":"122001",
"city":"Gurgaon",
"state":"Harayana",
"address1":"G-167,Sector40",
"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 Addressline1 Yes

address2 Varchar Addressline2 Yes

hub_phone Numeric Valid 10 digit Yes

phone number

delivery_type_id Numeric (Can have Id describing

values as 1/2/3 hub’s service No (Takes
only) type default value as
1 -Express 1 i.e. Express)
2 -Economy
3 -Bulk

5
Successful Case:

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"info":"Hub registered successfully",
"hub_id":1239
},
"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:https://api.smartship.in/v2/app/Fulfillmentservice/orderRegistrationOneStep

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):

{
6
"request_info":{
"client_id":"",
"run_type":"create"
},
"orders":[
{
"client_order_reference_id":"TEST_23_935",
"shipment_type":1,
"order_collectable_amount":"1000",
"total_order_value":"0",
"payment_type":"cod",
"package_order_weight":"300",
"package_order_length":"12",
"package_order_height":"5",
"package_order_width":"8",
"shipper_hub_id":"28329",
"shipper_gst_no":"29ABCDE1234F2Z5",
"order_invoice_date":"20-10-2021",
"order_invoice_number":"TEST_COD_935",
"is_return_qc":"0",
"return_reason_id":"0",
"order_meta":{
"preferred_carriers":[
1,
3,
279
]
},
"product_details":[
{
"client_product_reference_id":"127779866",
"product_name":"Milton Bottle 750ML",
"product_category":"computer",
"product_hsn_code":"02069010",
"product_quantity":"1",
"product_invoice_value":"100",
"product_gst_tax_rate":"5",
"product_taxable_value":"100",
"product_sgst_amount":"2",
"product_sgst_tax_rate":"2",
"product_cgst_amount":"2",
"product_cgst_tax_rate":"2"
}
],
"consignee_details":{
"consignee_name":"Sachin Dubey",
"consignee_phone":"9876543210",

7
 "consignee_email":"[email protected]",
"consignee_complete_address":"Plot 1268 Ground Floor Toshika Niwas Sector
46 In front of Guru Nank Park",
"consignee_pincode":"122001"
}
}
]
}

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"total_records":1,
"total_success_orders":1,
"request_id":1277601,
"total_eliminated_orders":0,
"success_order_details":{
"orders":[
{
"index":0,
"client_order_reference_id":"TEST_23_935",
"request_order_id":4165281,
"cost_estimation":{
"forward":{
"freight_charges":"24.00",
"region":"Within City",
"fuel_surcharge":0,
"fuel_surcharge_percentage":"0.00",
"insurance_type":"fov",
"insurance_charges_percentage":"0.25",
"maximum_insured_value":"5000.00",
"insurance_charges":0.25,
"cod_charges":"30.00",
"shipping_cost":54.25,
"shipping_cost_tax_amount":9.765,
"total_shipping_cost":64.015
},
"rto":{
"fuel_surcharge":0,
"fuel_surcharge_percentage":"0.00",
"freight_charges":"24.00",
"region":"Within City",
"shipping_cost_tax_amount":4.32,
"total_shipping_cost":28.32

8
 }
},
"sc_confirmation_no":4129805,
"message":"Successfully Punched",
"transition":false,
"dss_carrier_allocation":true,
"carrier_name":"Delhivery-SS",
"awb_assigned":true,
"awb_number":"3159416113866",
"code":4,
"carrier_id":"3",
"carrier_code":"DSSE",
"route_code":"GGN/DPC"
}
],
"shipping_info":{
"label_url":"https://smartship.in/images/excel_upload/shipping_label/20-10-
2021/shipping-label-A4-b9df8bd80f2076d4da62b2f7c20779dc.pdf"
}
},
"errors":null
},
"extra":null
}

Status Codes & Order States:

Status Code Order States

Code1 Order Registered

Code2 Order Created Successfully

Code3 Dss Carrier Assigned

Code4 Awb no assigned

PointsToConsider:
● 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 a do.
● 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.

9
 ● 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:https://api.smartship.in/v2/app/Fulfillmentservice/orderRegistration

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
{
"request_info":{
"ip_address":"14.142.227.166",
"run_type":"create",
"browser_name":"Mozila",
"location":"Delhi",
"shipment_type":1
},
"orders":[
{
"client_order_reference_id":"TEST_ORDER-619",
"order_collectable_amount":"100",
"total_order_value":"150",
"payment_type":"cod",
"package_order_weight":"7400",
"package_order_length":"10",
"package_order_height":"10",
"package_order_width":"20",
"shipper_hub_id":"28329”,
“shipper_gst_no":"",
"order_invoice_date":"22-03-2021",
"order_invoice_number":"invoice12",
"order_meta":{
"preferred_carriers":[
1,
3,
279
]
},
10
"product_details":[
{
"client_product_reference_id":"P20",
"product_name":"Crucial 1TB SSD",
"product_category":"computer",
"product_hsn_code":"8471",
"product_quantity":"2",
"product_invoice_value":"1000",
"product_gst_tax_rate":"1.2",
"product_taxable_value":"100",
"product_sgst_amount":"5",
"product_sgst_tax_rate":"5",
"product_cgst_amount":"5",
"product_cgst_tax_rate":"5"
},
{
"client_product_reference_id":"P21",
"product_name":"HP Envy 360p Laptop",
"product_category":"computer",
"product_hsn_code":"8471",
"product_quantity":"3",
"product_invoice_value":"1000",
"product_gst_tax_rate":"1.2",
"product_taxable_value":"100",
"product_sgst_amount":"5",
"product_sgst_tax_rate":"5",
"product_cgst_amount":"5",
"product_cgst_tax_rate":"5"
},
{
"client_product_reference_id":"P22",
"product_name":"Hynix 16GB LPDDR4 RAM",
"product_category":"computer",
"product_hsn_code":"8471",
"product_quantity":"3",
"product_invoice_value":"1000",
"product_gst_tax_rate":"1.2",
"product_taxable_value":"100",
"product_sgst_amount":"5",
"product_sgst_tax_rate":"5",
"product_cgst_amount":"5",
"product_cgst_tax_rate":"5"
}
],
"consignee_details":{
"consignee_name":"Sachin Dubey",
"consignee_phone":"9555474254",

11
 "consignee_email":"[email protected]",
"consignee_complete_address":"Plot 1268 Ground Floor Toshika Niwas Sector
46 In front of Guru Nank Park",
"consignee_pincode":"122001"
}
}
]
}

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"summary":{
"start_time":"21-10-2021 11:53:12",
"end_time":"21-10-2021 11:53:12",
"time_taken":0.37027788162231445
},
"total_records":1,
"total_success_orders":1,
"request_id":1280994,
"total_eliminated_orders":0,
"success_order_details":[
{
"index":0,
"client_order_reference_id":"TEST_ORDER-619",
"request_order_id":4171896,
"cost_estimation":{
"forward":{
"freight_charges":318,
"region":"Within City",
"fuel_surcharge":0,
"fuel_surcharge_percentage":"0.00",
"insurance_type":"fov",
"insurance_charges_percentage":"0.25",
"maximum_insured_value":"5000.00",
"insurance_charges":0.375,
"cod_charges":"30.00",
"shipping_cost":348.375,
"shipping_cost_tax_amount":62.7075,
"total_shipping_cost":411.0825
},
"rto":{
"fuel_surcharge":12.5,
"fuel_surcharge_percentage":"10.00",
"freight_charges":125,
12
 "region":"Within City",
"shipping_cost_tax_amount":24.75,
"total_shipping_cost":162.25
}
},
"sc_confirmation_no":4136420,
"message":"Successfully Punched"
}
],
"errors":null
},
"extra":null
}
Request Field Details:

Field Name Data Type Description Mandatory

request_info Json json object containing Yes

request information

request_info-“ip_address” Varchar IP address from where No

request is being created

request_info-“run_type” Varchar Value can be either Yes

“validate”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

request_info-”shipment_typ Numeric ‘1’ for forward orders Yes

e” ‘2’ for return orders
Note*: For return
orders, the hub_id
becomes the delivery
address and
consignee_details
become the pickup
address
Orders Array Array containing Yes
(JSON information about each
objects ) order
orders Varchar Client’s order Yes
-“client_order_reference_id” reference identifier

13
orders Numeric Amount to be collected Yes
-“order_collectable_amount from customer. Non-zero
” in case of COD order.

orders-“total_order_value” Numeric Total order value Yes

orders- “payment_type” Varchar Payment mode. Can Yes

only be“cod”or“prepaid”

orders Numeric Weight of order in grams Yes

-“package_order_weight”

orders Numeric Length of Yes

-“package_order_length” package in
centimeters
orders Numeric Height of Yes
-“package_order_height” package in
centimeters
orders Numeric Width of Yes
-“package_order_width” package in
centimeters
orders-“shipper_hub_id” Numeric Registered hub_id of Yes
clientfrom whom order
needs to be picked

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

orders-“order_invoice_date” Varchar Date when order No

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

orders - “order_meta” Json Json object containing No

meta information about
each order
Orders - Array Carrier id of the carrier to No
“preferred_carriers” (integers) be applied on order

orders Varchar If total order value > 50K No

-“order_ewaybill_number” then
order_ewaybill_number is
mandatory
orders Varchar If total order value > 50K No
-“order_ewaybill_expiry_dat then
e” order_ewaybill_expiry_da
te is mandatory
product_details Array(Jso
nObjects)

14
product_details Varchar Client’s product No
-“client_product_reference_i id for reference
d”
product_detail Varchar Name of product Yes
s -“product_na
me”
product_details Varchar Category of product No
-“product_category”

product_details Varchar Hsn code of product No

-“product_hsn_code”
*
mandator
y in case
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 in
case of gst
clients
consignee_details Json Consignee details Yes
Object

consignee_detail Varchar Name of customer Yes

s -“consIgnee _na
me”
consignee_detail Varchar Phone number of customer Yes
s -“consIgnee_ph
one”
consignee_detail Varchar Email id of customer Yes
s -“consIgnee_em
ail”
consignee_details Varchar Address of customer Yes
-“consignee_complete_add
ress”

consignee_details Numeric Pincode of Yes

-“consignee_pincode” customer(destIna
tIon pincode)
“product_taxable_value” Numeric Selling price per Yes
quantity on whIch GST
tax is applicable
“product_sgst_amount” Numeric If the sgst/ugst tax is Yes

15
 applicable, then both If the
fields sgst and cgst are sgst/ugst tax
requIred.Else, is
igstismandatory. applicable,the
n both fields s
Note:* Please pass blank in gst andcgst are
other gst fields. Do not pass required.
‘0’ as 0 is tax applicable on Else, igst
some product categories is mandato
ry
“product_cgst_amount” Numeric If the sgst/ugst tax is Yes. If the
applicable, then both sgst/ugst tax
fields sgst and cgst are r is ap plIcabl
equIred.Else, igst is e,then both
mandatory. fields sgst and
Note:* Please pass blank in cgst are
other gst fields. Do not required.
pass‘0’ as 0is tax applicableo Else, igst
n some product categories is mandato
ry.
“product_igst_amount” Numeric If the sgst/ugst tax is Yes. If the
applicable, then both sgst/ugst tax
fields sgst /ugst and cgs is applIcabl
t are required. Else, e,then both
Igst is mandatory. fields sgst/ugs
Note:*Please pass blank in t and cgst are
other gst fields. Do not required.
pass ‘0’ as 0 is tax applicable Else,Igst is
on some product categories mandatory.

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

applicable, then both sgst/ugst tax
fields sgst /ugst and cgs is applIcabl
t are required. Else, e,then both
Igst is mandatory. fields sgst/ugs
Note:*Please pass blank in t and cgst are
other gst fields. Do not required.
pass ‘0’ as 0 is tax applicable Else,Igst is
on some product categories mandatory.

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

applicable, then both sgst/ugst tax
fields sgst /ugst and cgs is applIcabl
t are required. Else, e,then both
Igst is mandatory. fields sgst/ugs
Note:*Please pass blank in t and cgst are
other gst fields. Do not required.
pass ‘0’ as 0 is tax applicable Else,Igst is
on some product categories mandatory.

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

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

applicable, then both sgst/ugst tax
fields sgst /ugst and cgs is applIcabl
t are required. Else, e,then both
Igst is mandatory. fields sgst/ugs
Note:*Please pass blank in t and cgst are
other gst fields. Do not required.
pass ‘0’ as 0 is tax applicable Else,Igst is
on some product categories mandatory.

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

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

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"

17
 “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”

“success_order_details- Smartship request order_id

request_order_id”

“success_order_details-message” Message regarding punched order.

errors Array of errors for orders which got

eliminated. Null if no errors found

“errors - Array containing information of orders in

mandatory_fields_missing” which some mandatory fields are missing

“errors-missing_field” Name of the mandatory field which is missing

“errors - Array containing information of orders in

mandatory_field_value_missing” which value 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:https://api.smartship.in/v2/app/Fulfillmentservice/orderDetails

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
18
{
"filters":{
"filter_type":{
"and":{
"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
}
}

Request Field Details:

Name Type Description IsMandatory?

status_code Varchar Contains smartship No

status codes
comma separated

check_type Varchar Contains No

character Y or N (Y
for in status) and
(N for not in
status)
request_order_id Varchar Contains comma No
separated
request order ids

19
 client_order_refere Varchar Contains No
nce_id comma
separated client
order reference
id
payment_type Varchar Contains payment No
type (cod or
prepaid)
created_date JsonObject from:starting No
date, to:ending
date Date
Format:“yyyy-mm-
dd”
updated_date JsonObject from:starting No
date, to:ending
date Date
Format:“yyyy-mm-
dd”
sort_by JsonObject fields:name of No
fields to sort
order details,
type: asc or desc

limit JsonObject offset:value of No

offset,
limit:value of
total number of
records

Response(Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"summary":{
"start_time":"11-05-201813:15:13",
"end_time":"11-05-201813: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",

20
 "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-0000:00:00",
"added_on":"2018-03-2912:41:17",
"Updated_on":"2018-04-1713:49:56",
"status_description":"NonServiceable"
},
"hub_details":{
"shipper_hub_id":"1234",
"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_details":{
"consignee_id":"124",
"consignee_name":"Anil01",
"consignee_address":"Sector40",
"consignee_pincode":"122001",
"consignee_email":"[email protected]",
"consignee_phone":"9444877840",
"”consignee_city”":"”Gurgaon”",
"consignee_state":"Haryana",
"consignee_state_code":"HR",
"consignee_country_code":"IN"
},
"product_details":[
{

21
 "order_product_id":null,
"request_order_id":"121",
"client_product_reference_id":"P00001",
"client_product_reference_type":"client",
"product_name":"Round Neck Dark Blue T-ShirtSize 01",
"product_category":"fashion",
"product_hsn_code":"50072010",
"product_price":"0",
"product_discount":null,
"product_quantity":"1",
"product_invoice_value":null,
"product_gst_tax_rate":null,
"added_on":"2018-03-2912:41:17",
"updated_on":"0000-00-0000:00:00",
"product_meta_id":null,
"key":null,
"value":null
},
{
"order_product_id":null,
"request_order_id":"121",
"client_product_reference_id":"P00002",
"client_product_reference_type":"client",
"product_name":"Round Neck Dark Blue T-ShirtSize 02",
"product_category":"fashion",
"product_hsn_code":"50072011",
"product_price":"0",
"product_discount":null,
"product_quantity":"2",
"product_invoice_value":null,
"product_gst_tax_rate":null,
"added_on":"2018-03-2912:41:17",
"updated_on":"2018-05-1112: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":{
"order_meta_id":"338712",
"carrier_name":"Xpressbees"
},

22
 "awb_no":{
"order_meta_id":"338715",
"awb_no":"1386418000163"
}
}
}
}
},
"extra":null
}

Response Field Details:

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_typ Client order reference type of order

e
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

package_order_width Package width

package_order_height Package height

status Smartship status of order

23
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_dat Expiry date of ewaybill number

e
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

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

24
 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

PointsToConsider:
● 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:
https://api.smartship.in/v2/app/Fulfillmentservice/createManifest

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
{
"client_order_reference_ids":[
"TEST_23_937"
],
"preferred_pickup_date":"",
"shipment_type":1
}

Request Field Details:

25
 Field Name Type Description Is Mandatory?

client_order_reference_ids Array Client order referen No

ce ids of orders

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"errors":null,
"valid_orders_for_manifest_creation":[
"TEST_23_937"
],
"manifest_details":{
"hub_id":{
"28329":{
"carrier_ids":{
"3":{
"order_id":[
"TEST_23_937"
],
"manifest_id":951368,
"carrier_name":"Delhivery-SS"
}
}
}
}
},
"summary":{
"request_id":1260182,
"total_orders_count":1,
"total_success_orders_count":1,
"failed_order_count":0,
"manifest_ids":[
951368
],
"manifest_pdf":{
"manifest_url":"https://smartship.in/images/excel_upload/manifest_pdf/
manifest-details-20a9fd0aa4e23733acdbfac3345fe1dc-21-10-2021.pdf",
"file_size":8169
},
"start_time":"21-10-2021 10:26:45",
"end_time":"21-10-2021 10:26:45",
26
 "time_taken":0.249284029006958
}
},
"extra":null
}

Response Field Details:

Field Name Type Description

summary JsonObject Summary of response

“summary-total_orders_count” Varchar Count of total

orders processed

“summary - Varchar Count of total

total_success_orders_count” successfully manifeste
d orders
“summary-manifest_ids” Array Generated manifest ids

“summary–manifest_pdf” JsonObject Manifest PDF details

“summary-manifest_url” JsonObject URL of manifest PDF

“summary-start_time” Varchar Start time of api

“summary-end_time” Varchar End time of api

errors JsonObject Errors with

descriptions while
creating manifests
manifest_details JsonObject Manifest Details

“manifest_details-hub_ids” JsonObject Details of manifests

hub wise

“manifest_details-carrier_ids” JsonObject Details of manifests

carrier ID wise

“manifest_details-order_id” Array Manifest Order Ids

“manifest_details- Numeric Manifest Id

manifest_id”
“manifest_details - Varchar Name of carrier
carrier_name”

SMARTSHIP UTILITY APIs

1) Get Hub Details API
27
URL:https://api.smartship.in/v2/app/Fulfillmentservice/getHubDetail

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Successful Cases:

a) Request(Json):
{
"hub_ids":
[1221,
1234
]
}

Response(Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"valid_hubs":{
"1355":{
"hub_name":"Delhi Warehouse",
"hub_phone":"9999613323",
"pincode":"122001",
"city":"Gurgaon",
"state":"Haryana",
"address1":"G-167,Sector40",
"address2":"FirstFloor,NearPoliceStation"
}
},
"invalid_hub_ids":[

]
},
"extra":null
}

b) Request (Json):
{
28
 "hub_ids":""
}

Response (Json):
{
"status":1,
"code": 200,
"message": "success",
"data":{
"valid_hubs"
: {"1234":{
"hub_name": "Delhi
Warehouse",
"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
}

Failed Case:

Request (Json):
{
"hub_ids":
[1923,
1253
]
}

Response (Json):
{

29
 "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:https://api.smartship.in/v2/app/Fulfillmentservice/updateHubDetails

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Successful Case:

Request (Json):
{
"hub_id":"1234",
"hub_name":"Delhi Warehouse",
"hub_phone":"9999613323",
"pincode":"122001",
"city":"Gurgaon",
"state":"Haryana",
"address1":"ad1",
"address2":"ad2"
}

Response (Json):
{
"status":1,
"code": 200,
"message": "success",
"data":{
"info":"hub data updated successfully"

30
 },
"extra":null
}

Failed Cases:

1) Request (Json):
{
"hub_id":"1354",
"hub_name": "Delhi
Warehouse",
"hub_phone":"9999613323",
"pincode":"226004",
"city": "Lucknow",
"state": "Uttar
Pradesh",
"address1":"ad1",
"address2":"ad2"
}

Response (Json):
{
"status":0,
"code": 200,
"message": "OK",
"data":{
"message":{
“info":"invalid hub_id"
}
},
"extra":null
}

2) Request (Json):
{
"hub_id":"1236",
"hub_name": "Delhi
Warehouse",
"hub_phone":"9999613323",
"pincode":"226004",
"city":"Lucknow",
"state":"",
"address1":"ad1",
"address2":"ad2"
}

Response (Json):

31
{
"status":200,
"code":41000,
"message":"invalid_inputs",
"data":null,
"extra":null
}

3) Request (Json):
{
"hub_id":"1235",
"hub_name": "Delhi
Warehouse",
"hub_phone":"9999613323",
"pincode":"22600",
"city": "Lucknow",
"state": "uttar pradesh",
"address1":"ad1",
"address2":"ad2"
}

Response (Json):
{
"status":0,
"code":200,
"message":"OK",
"data":{
"message":{
"info":"Hub data invalid",
"validation_error":[
"invalid pincode"
]
}
},
"extra":null
}

3) Delete Hub API

URL:https://api.smartship.in/v2/app/Fulfillmentservice/deleteHub

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST
32
Successful Case:
Request (Json):
{
"hub_ids":
[1237
]
}

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"info":"hub deleted successfully"
},
"extra":null
}

Failed Case:
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

33
URL:https://api.smartship.in/v2/app/Fulfillmentservice/getShippingLabels

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
{
"request_order_id":"184,183",
”client_order_ref_id”:"od02"
}

Request Field Details:

Field Name Data Type Description Is Mandatory?

request_order_id Varchar Comma No

Separated Smart
Ship Order id
client_order_ref_id Varchar Comma No
Separated C l i e n
t’s Reference Ord
er Id

Note:One of the above field is mandatory

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"error":{
"invalid_request_order_ids":[

]
},
"url":"http://admin.smartship.in/images/excel_upload/shipping_label/16-04-2018/
shipping-label-f0d9bb91b344618ab9fcf740c0e62526.pdf"
},
"extra":null
}

34
5) Cancel Order API

URL:https://api.smartship.in/v2/app/Fulfillmentservice/orderCancellation

OR
https://api.smartship.in/v2/app/Fulfillmentservice/orderCancel

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
{
"request_info":{
"ip_address":"14.142.227.166",
"”browser_name”":"”Mozilla”",
"location":"Delhi"
},
"orders":{
"client_order_reference_ids":[
"OD00200",
"OD00201"
],
"request_order_ids":[

]
}
}

Request Field Details:

Field Name Data Type Description Is Mandatory?

ip_address Varchar IP address No

browser_name Varchar Name of browser No

Location Varchar Location Name No

client_order_reference_id Varchar Comma separated

s client order Provide either
reference ids client_order_referen
ce_ids or
Request_order_ids Varchar Comma request_order_ids
separated Smar

35
 tShip 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
}

Response Field Details:

Field Name Description

Failure message (Change Cancellation is not allowed in this order status

Order Status Priviledge
Denied )
successful Successfully Cancelled orders

extra Any extra information

6) Hub Serviceability API

URL:https://api.smartship.in/v2/app/Fulfillmentservice/ServiceabilityHubWise

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:

36
POST

Request (Json):

1. For forward order use field “destination_pincode”

{
"order_info":{
"hub_ids":[
1353
],
"destination_pincode":122001,
"order_weight":500,
"preferred_carriers":[
302
]
},
"request_info":{
"extra_info":true,
"cost_info":true
}
}

2. For return order use field “source_pincode”

{
"order_info":{
"hub_ids":[
1353
],
"source_pincode":122001,
"order_weight":500,
"preferred_carriers":[
302
]
},
"request_info":{
"extra_info":false,
"cost_info":true
}
}
OR

Request (json):
{
"order_info":{
"source_pincode":122001,
"destination_pincode":122050,
"order_weight":0,

37
 "order_value":0,
"preferred_carriers":[
1,3,279
],
"delivery_type":1
},
"request_info":{
"extra_info":false,
"cost_info":false
}
}

Request Field Details:

Field Name Data Type Description Is Mandatory?

hub_ids Numeric Comma Yes

separated hub
ids
source_pincode Numeric Pincode to check Yes (In case
for serviceability checking
serviceability
for return
order)
destination_pincode Numeric Pincode to check Yes (In case
for serviceability checking
serviceability
for forward
order)
extra_info Boolean If detailed info No
for carriers
required send
true
cost_info Boolean If detailed info No
for cost
required send tr
ue

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"serviceability_status":true,
"hub_serviceability":{
"1353":{
"pickup_cod_serviceability_status":true,
38
 "pickup_prepaid_serviceability_status":true,
"pickup_serviceability_status":true,
"delivery_cod_serviceability_status":true,
"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":"WithinCity"
},
"hub_id":1353
}
},
"time_taken":0.083376169204712,
"request_id":"1pUfqG"
},
"extra":null
}

Response Field Details:

Field Name Description

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

delivery_service_carriers when
disable_carriers_on_hub extra_info flag set as true)

7) Hub Serviceable Pin Codes API

URL:https://api.smartship.in/v2/app/Fulfillmentservice/HubServiceablePincodes

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

39
Method:
POST

Request (Json):

{
"request_info":
{"format":"csv"
},
"hub_info":{
"start":10,
"limit":3,
"hub_id":1353
}
}

Request Field Details:

Field Name Data Type Description Is Mandatory?

format Varchar “csv” - to get No

csv download
link
null - to fetch
result as JSON
body
hub_id Numeric Hub id for which Yes
list of
serviceable
pincodes
required
start Numeric Defines starting No
point for the
records to be
fetched
limit Numeric Defines no No
of records
to be
fetched

Response (Json):

1. When format is “csv”

{
"status":1,
"code":200,

40
 "message":"success",
"data":{
"serviceable_pincodes":{
"hub_serviceable_pincodes":{
"data_url":"http://smartship.in/images/
excel_upload/mis_data/Hub-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,
"message":"success",
"data":{
"serviceable_pincodes":[
{
"destination_pincode":"110011",
"cod_carriers":"1",
"prepaid_carriers":"1",
"region_id":"1",
"region_name":"WithinCity"
},
{
"destination_pincode":"110012",
"cod_carriers":"1",
"prepaid_carriers":"1",
"region_id":"1",
"region_name":"WithinCity"
},
{
"destination_pincode":"110013",
"cod_carriers":"1",
"prepaid_carriers":"1",
"region_id":"1",

41
 "region_name":"WithinCity"
}
],
"start":10,
"limit":3,
"time_taken":4.2417559623718
},
"extra":null
}

8) Combined Manifest PDF for Already Manifested Orders

URL:https://api.smartship.in/v2/app/Fulfillmentservice/getOrdersManifestPdf

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):
{
"client_order_reference_ids":
["OD00200"
]
}

OR

{
"manifest_ids":[
1323910
]
}

Request Field Details:

Field Name Data Type Description Is Mandatory?

client_order_reference_id Varchar Comma Yes

s separated clIent
order reference
ids

*Orders should
42
 already be in
manifested
status
manifest_ids Numeric Comma Yes
seperated
manifest ids

*Orders should
already be in
manifested
status

Successful Response (JSON):

{
"status":1,
"code":200,
"message":"success",
"data":{

"summary":[

],
"manifest_details":{

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

Failure Response(JSON)
{
"status":1,
"code":200,"message":"suc
cess","data":{
"manifest_details":false,
"error":"No valid order found"
},
"extra":null
}

43
Response Field Details:

Field Name Description

Failure message (Change Cancellation is not allowed in this order status

Order Status Priviledge
Denied)
successful Successfully Cancelled orders

extra Any extra information

44
9) Carrier Serviceable Pincodes API
URL: http://api.smartship.in/v2/app/Fulfillmentservice/CarrierServiceablePincodes

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request (Json):

{
"carrier_info":{
"payment_type":"",
"carrier_id":[
"279"
]
}
}

Response (Json):

{
"status":1,
"code":200,
"message":"success",
"data":{
"279":{
"valid_pincode":{
"count":3844,
"data_url":"http://fqaadmin.smartship.in/images/excel_upload/mis_data/Carrier-
279-23-03-2022.csv",
"file_size":76916
},
"invalid_pincode":{
"count":0,
"data_url":null,
"file_size":null
}
}
},
"extra":null
}

45
Request Field Details:

Field Name Type Description Is Mandatory?

“carrier_info” JsonObject Json object Yes

containing
request
information
“carrier_info- Varchar Payment type No
payment_type” i.e COD,
prepaid

“carrier_info-carrier_id” Varchar Carrier id of Yes

desired
carrier or
pass “all” for
all carriers

10 Order Reattempt API

URL:-
http://api.smartship.in/v2/app/Fulfillmentservice/orderReattempt

Header:
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
POST

Request(JSON):

{
"orders": [
{
"request_order_id": "10977589",
"action_id": "1",
"comments": "la",
"next_attempt_date": "2023-04-01",
"client_order_reference_id": [""],
"address": "test_addresss",
"phone" : 9876543211,
"names" : "sachin",
"alternate_address" : "Unitech Cyber Park",
"alternate_number" : ""
}

46
 ]
}

Response(JSON):-

{
"status": 1,
"code": 200,
"message": "success",
"data": {
"success_orders": [
{
"request_order_id": "10977589",
"action_id": "1",
"comments": "la",
"next_attempt_date": "2023-04-01",
"client_order_reference_id": "NDR_test_op",
"address": "test_addresss",
"phone": 9876543211,
"names": "sachin",
"alternate_address": "Unitech Cyber Park",
"alternate_number": ""
}
],
"errors": null
},
"extra": null
}

Request Field Details:

Field Name Type Description Is Mandatory?

“request_order_id” Integer Unique Yes, if

Smartship client_order_refere
Order ID nce_id not provied.

“client_order_reference_i Varchar Multiple Yes,if

d” client_order_r request_order_id
eference_ids not provided
can be
passed
“action” Integer 1 – for Yes
reattempt
2 – for RTO
“comments” Varchar Comments to Yes
be provided

47
 for
requesting
NDR
“next_attempt_date” Date(YYYY- Next attempt Yes
mm-dd) date to be
passed
should be
greater than
today but
less than
next 10 days
from current
date

“address” Varchar Adress for Yes

NDR

“phone” Integer Mobile Yes

number for
NDR

“names” Varchar Name of Yes

person

“alternate_address” Varchar Alternate Optional

Address for
NDR

"alternate_number" Integer Alternate Optional

Number for
NDR

SMARTSHIP TRACKING APIs

1) Track Smartship Order API

URL:
https://api.smartship.in/v1/Trackorder?request_order_ids=130
OR
https://api.smartship.in/v1/Trackorder?order_reference_ids=OD00204

OR
https://api.smartship.in/v1/Trackorder?tracking_numbers=3159417320681

Header:

48
Content-Type: application/json
Authorization:BearerXXXXXX

Method:
GET

Response (Json):
{
"status":1,
"code":200,
"message":"success",
"data":{
"scans":{
"130":[
{
"request_order_id":"130",
"order_reference_id":"OD00204",
"tracking_number":"EQ235340552IN",
"carrier_name":"Aramex",
"date_time":"03-04-201812:08:41",
"location":"Panipat_PC (Haryana)",
"action":"Shipped to RTO",
"status_code":"",
"status_description":""
},
{
"request_order_id":"130",
"order_reference_id":"OD00204",
"tracking_number":"EQ235340552IN",
"carrier_name":"Aramex",
"date_time":"03-04-201812:08:40",
"location":"Panipat_PC (Haryana)",
"action":"Shipped to RTO",
"status_code":"",
"status_description":""
},
{
"request_order_id":"130",
"order_reference_id":"OD00204",
"tracking_number":"EQ235340552IN",
"carrier_name":"Aramex",
"date_time":"03-04-201812:08:40",
"location":"Panipat_PC (Haryana)",
"action":"RTO to RTO Delivered",
"status_code":"",
"status_description":""
},
49
 {
"request_order_id":"130",
"order_reference_id":"OD00204",
"tracking_number":"EQ235340552IN",
"carrier_name":"Aramex",
"date_time":"02-04-201812:08:40",
"location":"Delhi",
"action":"Manifested to shipped",
"status_code":"",
"status_description":""
},
{
"request_order_id":"130",
"order_reference_id":"OD00204",
"tracking_number":"EQ235340552IN",
"carrier_name":"Aramex",
"date_time":"02-04-201812:08:40",
"location":"Panipat_PC (Haryana)",
"action":"Shipped to RTO",
"status_code":"",
"status_description":""
},
{
"request_order_id":"130",
"order_reference_id":"OD00204",
"tracking_number":"EQ235340552IN",
"carrier_name":"Aramex",
"date_time":"02-04-201812:08:39",
"location":"Delhi",
"action":"Manifested to shipped",
"status_code":"",
"status_description":""
}
]
}
},
"extra":[

]
}

Response Field Details:

Field Name Description

request_order_id SmartShip Order ID

50
 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

0 Open

2 Confirmed

3 Shipping Label Generated

4 Manifested

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

19 RTO Delivered To Shipper

22 Delivery Attempted - Requested For Open Delivery

23 Delivery Attempted - Others

24 Courier Assigned

26 Cancellation Requested By Client

27 In Transit

28 RTO In Transit

51
30 Out For Delivery

36 Handed Over to Courier

48 Delivery Confirmed by Customer

59 In Transit Delay - ODA Location/ Area Not Accessible

118 RTO to be Refunded

185 Cancelled By Client

189 Forward Shipment Lost

198 RTO-Rejected by Merchant

199/201 RTO-Delivered to FC

207 Shipped - In Transit - Misrouted

209 Shipped - In Transit - Destination Reached

210 Delivery Not Attempted

212 RTO - In Transit - Damaged

214 Delivery Attempted-Refused by Customer with OTP

52
RATE CALCULATOR API SPECIFICATION

URL :https://api.smartship.in/v2/app/Fulfillmentservice/rateCalculator

Request:
{
"order_info":{
"email":"[email protected]",
"source_pincode":122001,
"destination_pincode":122050,
"order_weight":500,
"order_value":1000,
"payment_type": "cod", //cod or prepaid
"length": "10",
"width": "10",
"height": "10",
"shipment_type": "forward/return",
"preferred_carriers":[
1,3,279
]
},
"request_info":{
"extra_info":false
}
}

Respone:
{
"status":1,
"code":200,
"message":"success",
"data":{
"carrier_info":{
"1":{
"carrier_id":"3",
"carrier_name":"Delhivery SS"
"cost":"21.00",
"tat":"3.00",
"rto_cost":"21.00",
"region_name":"WithinCity"
},
"2":{
"carrier_id":"1",
"carrier_name":Bluedart-DartPlus"
"cost":"21.00",
"tat":"3.00",
"rto_cost":"21.00",
"region_name":"WithinCity"
}
},
"time_taken":0.083376169204712
}
}

53
Request Fields Details:

Fields Data Type Description Mandatory

email string email Yes
source_pincode Numeric Source Pincode Yes
destination_pincode Numeric Destination Pincode Yes
order_weight Numeric Order Weight. Default No
:300gm
order_value Numeric For prepaid orders : 0 Yes(for cod order only)
payment_type string For cod order: “cod”, Yes
For prepaid order:
“prepaid”
extra_info boolean No
length Numeric Length of package Yes
width Numeric Width of package Yes
height Numeric Height of package Yes
shipment_type string forward/return Yes

54
Requirements for callback functionality
1. Callback url and shared access token to be given by seller/merchant.

2. Sharing the sample request pushed by smarthship,

Sample request body we push:
{
"shipment_type": "1 for forward, 2 for reverse INTEGER VALUE",
"request_order_id": "0000",
"client_order_reference_id": "TEST-REFERENCE-ID-001",
"awbno": "110022003300",
"status": 4,
"status_code": "",
"status_description": "Manifested",
"statusUpdateDate": null,
"statusUpdateTime": null,
"from_location": "G-168, Sector 498 ~ Near Mothers Pride School",
"to_location": "G-168, Sector 67 ~ Near Mothers Pride School",
"current_location": "G-168, Sector 100 ~ Near Mothers Pride School",
"comments": "NA",
"reason_code": "",
"rto_awbno": "",
"received_by": "NA",
"payment_type": "",
"collectable_amount": "",
"longitude": "",
"latitude": "",
"shipment_pickup_time": "",
"delivery_agent_number": ""
}

3. Sample response required from seller end.

Sample response body we expect:
{
"data": {
"message": {
"success": true,
"description": "response message"
}
}
}

Also, scans are pushed twice and if no success response is received, then
further scans are not pushed.

55