API Documentation

Authentication:
Generate API-key from RapidShyp Portal to use it further to validate your API calls.

Path:

Setting>API>Configure

Generate your API-key:

Save the new API-key generated and use

UAT URL: https://uat.rapidshyp.com/api/rapidshyp/apis/v1/
LIVE URL: https://api.rapidshyp.com/rapidshyp/apis/v1/

Pincode Serviceability API:

Use this API to get pincode serviceability on the RapidShyp platform.

Basic Information
NAME DETAILS
Usage: Mandatory
URL: https://api.rapidshyp.com/rapidshyp/apis/v1/
serviceabilty_check
Request Type: POST
Scheme: HTTPS
Header (content-type) application/json
Header (rapidshyp-token): API-Key

Curl:
curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/serviceabilty_check' \
--header 'rapidshyp-token: e779a4*************8b60ba5f09ecd579fa1f34b64805e' \--header
'Content-Type: application/json' \
--data '{
"Pickup_pincode": "110068",
"Delivery_pincode": "110038",
"cod": true,
"total_order_value": 2000,
"weight": 1
}'
Request
Parameters Data type Remark Validation

Postcode from
where the order will
Pickup_pincode string Mandatory be picked. 6 digit pincode
Postcode where the
Delivery_pincod order will be
e string Mandatory delivered 6 digit pincode
True incase of cod
order and false
incase of prepaid
cod boolean Mandatory order
The price of the
total_order_valu order shipment in
e float Mandatory rupees.
The weight of
shipment in kgs.
weight float Mandatory

Response:
{
"status": true,
"remark": "Success",
"serviceable_courier_list": [
{
"courier_code": "6001",
"courier_name": "BlueDart Express",
"parent_courier_name": "BlueDart",
"cutoff_time": "14:00",
"freight_mode": "Surface",
"max_weight": 5000.0,
"min_weight": 1.0,
"total_freight": 11.111
}
]
}

Forward Wrapper API:

Use this API to do multiple tasks in one go, namely creating a quick order, requesting its
shipment, and finally generating the label and the manifest for the same order.

This API integrates several other APIs to perform all these tasks together.
Task:

● Create order
● Create shipment
● Run serviceability
● Check courier rule/priority
● Assign awb
● Generate pickup manifest
● Generate label pdf
● Generate invoice pdf
● Generate Manifest pdf

Basic Information
NAME DETAILS
Usage: Mandatory
URL: https://api.rapidshyp.com/rapidshyp/apis/v1/
wrapper
Request Type: POST
Scheme: HTTPS
Header (content-type) application/json
Header (rapidshyp-token): API-Key

Curl:
curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/wrapper' \
--header 'rapidshyp-token: HQ$f**********oZ \
--header 'Content-Type: application/json' \
--data-raw '{
"orderId": "Tango34",
"orderDate": "2023-06-30",
"pickupAddressName": "Home",
"pickupLocation": {
"contactName": "Mahesh Mehra",
"pickupName": "New Seller 110001",
"pickupEmail": "[email protected]",
"pickupPhone": "8094723198",
"pickupAddress1": "New Delhi Seller",
"pickupAddress2": "New Delhi 2 Seller",
"pinCode": "110001"
},
"storeName": "DEFAULT",
"billingIsShipping": true,
"shippingAddress": {
"firstName": "Mahesh Mehra",
"lastName": "EXT",
"addressLine1": "Delhi",
 "addressLine2": "New Delhi",
"pinCode": "110001",
"email": "[email protected]",
"phone": "8094723198"
},
"billingAddress": {
"firstName": "Jane",
"lastName": "Doe",
"addressLine1": "456 Elm St",
"addressLine2": "Apt 101",
"pinCode": "110001",
"email": "[email protected]",
"phone": "9876543211"
},
"orderItems": [
{
"itemName": "Product 1",
"sku": "SKU123",
"description": "Description of product 1",
"units": 5,
"unitPrice": 10.0,
"tax": 0.0,
"hsn": "HSN123",
"productLength": 10.0,
"productBreadth": 5.0,
"productHeight": 2.0,
"productWeight": 0.5,
"brand": "Brand A",
"imageURL": "http://example.com/product1.jpg",
"isFragile": false,
"isPersonalisable": false
},
{
"itemName": "Product 2",
"sku": "SKU456",
"description": "Description of product 2",
"units": 2,
"unitPrice": 20.0,
"tax": 0.0,
"hsn": "HSN456",
"productLength": 15.0,
"productBreadth": 7.0,
"productHeight": 3.0,
"productWeight": 0.8,
"brand": "Brand B",
"imageURL": "http://example.com/product2.jpg",
"isFragile": true,
"isPersonalisable": true
 }
],
"paymentMethod": "COD",
"shippingCharges": 100.0,
"giftWrapCharges": 0.0,
"transactionCharges": 0.0,
"totalDiscount": 0.0,
"totalOrderValue": 500.0,
"codCharges": 0.0,
"prepaidAmount": 0.0,
"packageDetails": {
"packageLength": 20.0,
"packageBreadth": 10.0,
"packageHeight": 5.0,
"packageWeight": 2000.0
}
}'

Request
Parameters Data type Remark Validation
{
Seller order ID on
channel/store/websi
orderId string Mandatory te Minimum 1 character
Order created date
on
channel/store/websi
orderDate string Mandatory te Format: YYYY-MM-DD
Pickup name API User can either pass pickup
created on name or create pickup.If both
Rapidshyp platform. details are shared,system will
Conditionall create order on the pickup name
pickupAddressN y- Suggested to use provided and will not create a new
ame string Mandatory this field for external pickup location.

Create Pickup
location on order
creation itself.

Only use if you

want to create a
Conditionall pickup location on
y- every single api
pickupLocation Mandatory call.
{
Location contact
contactName string Mandatory POC name Minimum 1 character
Name of the Pickup address name must be
pickupName string Mandatory warehouse/store between 3 and 75 characters long
Location contact
pickupEmail string Mandatory POC email
Location contact Phone number must start from
pickupPhone string Mandatory POC phone number 6,7,8,9
Warehouse/store Pickup address line 1 must be
address line 1 between 3 and 100 characters
pickupAddress1 string Mandatory long
Warehouse/store if entered,Pickup address line 2
Non- address line 2 must be between 3 and 100
pickupAddress2 string Mandatory characters long
pinCode string Mandatory Location Pincode Must be 6 digit valid pincode
},
Store name created If you have one custom
storeName string Mandatory on Rapidshyp channel,pass "DEFAULT"
Pass true if both shipping and
billing is same.Incase false, Billing
address can't be empty.

Incase you don't want to push

billing address,pass
billingIsShipping boolean Mandatory billingIsShipping as true
shippingAddress Mandatory
{
Customer first The combined length of the first
firstName string Mandatory name and last name in the shipping
address must be between 3 and
Non-
75 characters.
lastName string Mandatory Customer last name

Shipping address line 1 must be

Customer Address between 3 and 100 characters
addressLine1 string Mandatory line 1 long.
if entered,Shipping address line 2
Non- Customer Address must be between 3 and 100
addressLine2 string Mandatory line 2 characters long.
Customer address
pinCode string Mandatory pincode Must be 6 digit valid pincode
Non-
email string Mandatory Customer email
Customer phone Phone number must start from
phone string Mandatory number 6,7,8,9
},
Conditionall
y- Only pass incase billingIsShipping:
billingAddress Mandatory false,
{
Billing customer first The combined length of the first
firstName string Mandatory name and last name in the shipping
address must be between 3 and
Non- Billing customer last
75 characters.
lastName string Mandatory name

Billing address line 1 must be

Billing customer between 3 and 100 characters
addressLine1 string Mandatory Address line 1 long.
if entered,Billing address line 2
Non- Billing customer must be between 3 and 100
addressLine2 string Mandatory Address line 2 characters long.
Billing customer
pinCode string Mandatory Address Pincode Must be 6 digit valid pincode
Billing customer
email string Mandatory email
Billing customer Phone number must start from
phone string Mandatory phone number 6,7,8,9
},
orderItems Mandatory item level details
{
Order line item name must be
between 3 and 200 characters
itemName string Mandatory Item Name long.
Order line item sku must be
Non- between 3 and 200 characters
sku string Mandatory Item SKU Id long.
Non- Description of
description string Mandatory product Minimum 1 character
Item quantity must be greater than
units float Mandatory quantity of items 0 in items.
Item unit price must be greater
unitPrice float Mandatory Unit price of SKU than 0 in items.
tax float Mandatory Tax Pass 0 incase of zero tax item
Non-
hsn string Mandatory HSN code
Non- Product dimension
productLength float Mandatory length in cm
Non- Product dimension
productBreadth float Mandatory breadth in cm
productHeight float Non- Product dimension in cm
 Mandatory height
Non- Product dimension
productWeight float Mandatory Weight in kg
Non-
brand string Mandatory Brand of product
Non-
imageURL string Mandatory Image URL
If a fragile item,pass true.
Non- If you don't have such bifurcation
isFragile boolean Mandatory at your end,pass false by default.
if personlisable,pass true.
Non- If you don't have such bifurcation
isPersonalisable boolean Mandatory at your end,pass false by default.
},
],
Payment mode of payment mode please choose
paymentMethod string Mandatory order from [COD, PREPAID]
shippingCharge Non-
s float Mandatory Shipping charges
giftWrapCharge Non-
s float Mandatory giftWrapCharges
transactionChar Non-
ges float Mandatory transactionCharges
Non-
totalDiscount float Mandatory totalDiscount
totalOrderValue float Mandatory totalOrderValue
Non-
codCharges float Mandatory codCharges
Pass partially paid amount in case
of partial paid order.System then
calculates collectable
Non- amount.Prepaid amount is only
prepaidAmount float Mandatory prepaidAmount applicable on COD payment mode.
packageDetails Mandatory
{
packageLength float Mandatory packageLength in cm
packageBreadth float Mandatory packageBreadth in cm
packageHeight float Mandatory packageHeight in cm
packageWeight float Mandatory packageWeight in kg
}
}
Response:

{
"status": "SUCCESS",
"remarks": "",
"orderId": "T9",
"orderCreated": true,
"shipment": [
{
"shipmentId": "S24073186",
"awbGenerated": true,
"labelGenerated": true,
"pickupScheduled": true,
"awb": "71*******146",
"courierCode": "Ecom Express Surface",
"courierName": "Ecom Express Surface",
"parentCourierName": "Ecom Express",
"appliedWeight": 63.0,
"labelURL": "https://rapidshyp_labels/Label_10Jul24.pdf",
"manifestURL": "https://rapidshyp-public.s3.ap-south-1.amazonawsanifest_52.pdf",
"routingCode": "NOI",
"rtoRoutingCode": "NOI",
"pickupName": "Home",
"paymentMethod": "COD",
"shippingCharges": 100.0,
"giftWrapCharges": 0.0,
"transactionCharges": 0.0,
"totalDiscount": 0.0,
"totalOrderValue": 150.0,
"prepaidAmount": 0.0,
"collectableAmount": 150.0,
"shipmentLines": [
{
"name": "Pwerew",
"sku": "Sqwer",
"units": 1,
"sellingPrice": 10.0
},
{
"name": "Product 2",
"sku": "Product 2",
"units": 2,
"sellingPrice": 40.0
}
]
 }
]
}

De-allocate Shipment API:

Use this API to de-allocate awb from shipment order at Rapidshyp.You can re-call awb API
again to generate fresh awb for the same shipment.

Basic Information
NAME DETAILS
Usage: Mandatory
URL: https://api.rapidshyp.com/rapidshyp/apis/v1/
de_allocate_shipment
Request Type: POST
Scheme: HTTPS
Header (content-type) application/json
Header (rapidshyp-token): API-Key

Curl:

curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/de_allocate_shipment' \

--header 'rapidshyp-token: HQ$f**********oZ \
--header 'Content-Type: application/json' \
--data '{
"orderId": "Tango2",
"shipmentId": "S2407199"
}'

Request
Parameters Data type Validation
{
Order is created on
orderId string Mandatory Rapidshyp should be a valid order id
Shipment is created
shipmentId string Mandatory on Rapidshyp should be a valid shipment id
}

Response:
{
"status": true,
"remarks": "Shipment successfully de-allocated."
}

Cancel Order API:

Usage: Use this API to cancel a created order.

Basic Information
NAME DETAILS
Usage: Mandatory
URL: https://api.rapidshyp.com/rapidshyp/apis/v1/
cancel_order
Request Type: POST
Scheme: HTTPS
Header (content-type) application/json
Header (rapidshyp-token): API-Key

Curl:
curl --location 'https://api.rapidshyp.com/api/rapidshyp/apis/v1/cancel_order' \
--header 'rapidshyp-token: HQ$f**********oZ' \
--header 'Content-Type: application/json' \
--data '{
"orderId": "Tango2",
"storeName": "DEFAULT"
}'

Request
Parameters Data type Remark Validation
{
Order id created on
orderId string Mandatory Rapid Shyp should be a valid order id
storeName string Mandatory store name of order should be a valid store name id
 on Rapidshyp
}

Response:

{
"status": true,
"remarks": "Order canceled successfully."
}

Label PDF Generation API:

Use this API to generate Label PDF.

Basic Information
NAME DETAILS
Usage: Mandatory
URL: https://api.rapidshyp.com/rapidshyp/apis/v1/
generate_label
Request Type: POST
Scheme: HTTPS
Header (content-type) application/json
Header (rapid ship-token): API-Key

Curl:

curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/generate_label' \

--header 'rapidshyp-token: HQ$fS*******KHoZ' \
--header 'Content-Type: application/json' \
--data '{
"shipmentId": ["S2407199"]
}'

Request Data type Validation

 Parameters
{
Shipment id created
shipmentId strinf Mandatory on Rapid Shyp should be a valid shipment id
}

Response:
{
"status": true,
"remarks": "Label(s) generated successfully.",
"labelData": [
{
"shipmentId": "S2407199",
"labelURL": "https://rapidshyp-public.s3.ap-south-
1.amazona****************2:46PM.pdf",
"labelRemarks": "Label generated successfully."
}
]
}

Tracking:

Use this API to fetch awb tracking.

Basic Information
NAME DETAILS
Usage: Mandatory
URL: https://api.rapidshyp.com/rapidshyp/apis/v1/
track_order
Request Type: POST
Scheme: HTTPS
Header (content-type) application/json
Header (rapidshyp-token): API-Key
Request Sample:

"seller_order_id": "O24025",

"contact": "455432345 ",

"email": "[email protected]",

"awb": "RAPP0000000001"

Request
Parameters Data type Validation
order id of order
Conditional created on
seller_order_id string mandatory Rapidshyp Either order id is required or awb
contact string Api user to share any of these
details in case tracking is fetched
email string based on order id.
awb of shipment
where awb is
Conditional assigned on
awb string mandatory Rapidshyp Either order id is required or awb

Curl Request:
curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/track_order' \
--header 'rapidshyp-token: 758e3645*************************7e1bff62f73f2589e8' \
--header 'Content-Type: application/json' \
--data '{
"orderId": "",
"awb": "776*****803",
"contact": "",
"email": ""
}'

Response:

{
"success": true,
"msg": "Fetched successfully.",
"records": [
{
"seller_order_id": "67317",
"creation_date": "19-11-2024 07:12:41",
"payment_method": "COD",
"total_order_value": 1399.0,
"store_name": "test",
"store_brand_name": "Test",
"store_id": null,
"shipping_name": "Surya M",
"shipping_email": "[email protected]",
"shipping_contact": "918606201226",
"shipping_address": "BKP commercial India, opp.union bank",
"shipping_address_2": "",
"shipping_city": "ADOOR",
"shipping_pin_code": "689502",
"shipping_state": "KERALA",
"shipping_country": "INDIA",
"billing_name": "Surya M",
"billing_email": "[email protected]",
"billing_contact": "918606201226",
"billing_address": "BKP commercial India, opp.union bank",
"billing_address_2": "",
"billing_city": "ADOOR",
"billing_pin_code": "689502",
"billing_state": "KERALA",
"billing_country": "INDIA",
"customer_gstin": "",
"order_status": "CLOSED",
"shipment_details": [
{
"shipment_id": "S2411122366",
"shipment_creation_date": "19-11-2024 07:12:41",
"total_shipment_value": 1399.0,
"collectable_amount": 1399.0,
"pickup_warehouse_name": "Ghitorni 1",
"warehouse_contact_name": "Bucketberry",
"warehouse_email": "[email protected]",
"warehouse_contact": "9205460699",
"warehouse_address": "100 feet road, Ghitorni Village, New Delhi",
"warehouse_address_2": "100 feet road, Ghitorni Village, New Delhi",
"warehouse_pin_code": "110030",
"warehouse_city": "DELHI",
"warehouse_state": "DELHI",
"warehouse_country": "INDIA",
"rto_warehouse_name": "Ghitorni 1",
"rto_warehouse_contact_name": "Bucketberry",
"rto_warehouse_email": "[email protected]",
"rto_warehouse_contact": "9205460699",
"rto_warehouse_address": "100 feet road, Ghitorni Village, New Delhi",
"rto_warehouse_address_2": "100 feet road, Ghitorni Village, New Delhi",
 "rto_warehouse_pin_code": "110030",
"rto_warehouse_city": "DELHI",
"rto_warehouse_state": "DELHI",
"rto_warehouse_country": "INDIA",
"length": 18.0,
"breadth": 18.0,
"height": 7.0,
"dead_weight": 0.2,
"applied_weight": 0.4536,
"invoice_number": "",
"shipment_status": "DELIVERED",
"awb": "77********803",
"courier_name": "BlueDart",
"child_courier_name": "BlueDart Express",
"awb_assigned_date": "19-11-2024 11:04:35",
"current_courier_edd": "27-11-2024 00:00:00",
"current_tracking_status_code": "DEL",
"current_tracking_status_desc": "Delivered",
"current_status_date": "27-11-2024 17:35:00",
"latest_ndr_reason_code": "UND01",
"latest_ndr_reason_desc": "Address Incomplete/Incorrect",
"latest_ndr_date": "27-11-2024 17:22:00",
"product_details": [
{
"product_name": "Women Wireless Sexy Push Up Sports Stylish Tank Top
Bralette - Pack of 4 (Hot Selling), XL-xl-Orange\r\nBlue\r\nGreen\r\nPinkish",
"product_sku": "33_4_XL",
"product_qty": 1
}
],
"track_scans": [
{
"scan_datetime": "19-11-2024 11:04:35",
"scan": "Shipping Label Generated",
"scan_location": ""
},
{
"scan_datetime": "19-11-2024 11:05:33",
"scan": "Manifested",
"scan_location": ""
},
{
"scan_datetime": "19-11-2024 16:25:00",
"scan": "PICK UP SCAN ON FIELD",
"scan_location": "DARTPLUS GOPINATH"
},
{
"scan_datetime": "20-11-2024 13:11:00",
 "scan": "Re-Way",
"scan_location": "GURUGRAM"
},
{
"scan_datetime": "20-11-2024 13:18:00",
"scan": "SHIPMENT INSCAN",
"scan_location": "COD PROCESSING CENTRE II"
},
{
"scan_datetime": "21-11-2024 03:22:00",
"scan": "SHIPMENT OUTSCANNED TO NETWORK",
"scan_location": "COD PROCESSING CENTRE II"
},
{
"scan_datetime": "23-11-2024 08:17:00",
"scan": "DIRECT CANVAS BAG SCANNED",
"scan_location": "BIAL HUB"
},
{
"scan_datetime": "23-11-2024 12:39:00",
"scan": "SHIPMENT OUTSCANNED TO NETWORK",
"scan_location": "BIAL HUB"
},
{
"scan_datetime": "24-11-2024 09:47:00",
"scan": "SHIPMENT INSCAN",
"scan_location": "KOCHIN MINI HUB"
},
{
"scan_datetime": "24-11-2024 16:03:00",
"scan": "COMM FLIGHT VEH TRAIN DELAYED CANCELLED",
"scan_location": "KOCHIN MINI HUB"
},
{
"scan_datetime": "25-11-2024 07:07:00",
"scan": "SHIPMENT OUTSCANNED TO NETWORK",
"scan_location": "KOCHIN MINI HUB"
},
{
"scan_datetime": "25-11-2024 09:09:00",
"scan": "CANVAS BAG CONSOLIDATED SCAN",
"scan_location": "KOTTAYAM"
},
{
"scan_datetime": "25-11-2024 09:11:00",
"scan": "SHIPMENT OUTSCANNED TO NETWORK",
"scan_location": "KOTTAYAM"
},
 {
"scan_datetime": "25-11-2024 11:38:00",
"scan": "SHIPMENT INSCAN",
"scan_location": "ADUR"
},
{
"scan_datetime": "25-11-2024 14:03:00",
"scan": "DELIVERY SCHEDULED FOR NEXT WORKING DAY",
"scan_location": "ADUR"
},
{
"scan_datetime": "26-11-2024 14:50:00",
"scan": "SHIPMENT OUTSCAN",
"scan_location": "ADUR"
},
{
"scan_datetime": "26-11-2024 16:41:00",
"scan": "ADDRESS INCOMPLETE INCORRECT",
"scan_location": "ADUR"
},
{
"scan_datetime": "27-11-2024 09:47:00",
"scan": "SHIPMENT OUTSCAN",
"scan_location": "ADUR"
},
{
"scan_datetime": "27-11-2024 17:36:14",
"scan": "Open",
"scan_location": "Delhi"
},
{
"scan_datetime": "27-11-2024 17:22:00",
"scan": "ADDRESS INCOMPLETE/ INCORRECT",
"scan_location": "ADUR"
},
{
"scan_datetime": "27-11-2024 17:52:12",
"scan": "Open",
"scan_location": "Delhi"
},
{
"scan_datetime": "27-11-2024 17:35:00",
"scan": "SHIPMENT DELIVERED",
"scan_location": "ADUR"
}
],
"delivered_date": "27-11-2024 17:35:00",
"rto_delivered_date": null,
 "edd": "27-11-2024 00:00:00"
}
]
}
]
}

Tracking status code Rapidshyp:

Rapishyp Tracking Status Code Status Description
SCB Shipment Booked
PSH Pickup Scheduled
OFP Out for Pickup
PUE Pick up Exception
PCN Pickup Cancelled
PUC Pickup Completed
SPD Shipped/Dispatched
INT In Transit
RAD Reached at Destination
DED Delivery Delayed
OFD Out for Delivery
DEL Delivered
UND Undelivered
RTO_REQ RTO Requested
RTO RTO Confirmed
RTO_INT RTO In Transit
RTO_RAD RTO - Reached at Destination
RTO_OFD RTO Out for Delivery
RTO_DEL RTO Delivered
RTO_UND RTO Undelivered
CAN Shipment Cancelled
ONH Shipment On Hold
LST Shipment Lost
DMG Shipment Damaged
MSR Shipment Misrouted
DPO Shipment Disposed-Off