Return Wrapper With QC Api

The Return Wrapper API is used to create a return/reverse pickup order. It supports Quality Check (QC) enabled returns, where QC-related product information, including product images and item attributes, can be provided as part of the request.

Basic Information

Parameter	Details
API Name	Return Wrapper API
Method	POST
Endpoint	`https://api.rapidshyp.com/rapidshyp/apis/v1/return_wrapper`
Content-Type	`application/json`
Authentication	`rapidshyp-token`
QC Support	Yes

Curl:

curl --location 'https://api.rapidshyp.com/rapidshyp/apis/v1/return_wrapper' \
--header 'rapidshyp-token: <YOUR_RAPIDSHYP_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderId": "return_wrap_qc_uat_23",
    "orderDate": "2026-08-15",
    "is_qc_enabled": true,
    "pickupLocation": {
        "pickup_customer_name": "DO EPIC SHISP",
        "pickup_customer_last_name": "DO EPIC SHSIPP",
        "pickup_email": "avdhesh@omlogistics.com",
        "pickup_phone": "9999999999",
        "pickup_address": "abGGG",
        "pickup_address_2": "GG",
        "pickup_pincode": "110001"
    },
    "storeName": "",
    "return_reason_code": "",
    "deliveryAddress_name": "",
    "deliveryAddress": {
        "deliverylocation_name": "RAPIDSHYP",
        "contact_name": "Abhinavqaqa",
        "delivery_address1": "abxhA hhhhhhhhhhhhhd gggggggggg",
        "delivery_address2": "abxAhd hhhhhhhhhhhhhh gggggb hhh h",
        "pincode": "110001",
        "delivery_email": "avdhesh.bhardwaj@omlogistics.co.in",
        "delivery_phone": "9999999999"
    },
    "orderItems": [
        {
            "itemName": "ARP1TEST0023",
            "sku": "ARPTEST10023",
            "units": 2,
            "unitPrice": 50.0,
            "tax": 0.0,
            "hsn": "HSN456",
            "productLength": 11.0,
            "productBreadth": 12.0,
            "productHeight": 12.0,
            "productWeight": 3.0,
            "brand": "",
            "serial_no": "",
            "imei_no": "",
            "images_name": [
                "https://i.pinimg.com/736x/14/ec/3f/14ec3ff15e3335264723fe39fb9da735.jpg"
            ],
            "color": "red",
            "size": "L"
        }
    ],
    "packageDetails": {
        "packageLength": 11.0,
        "packageBreadth": 11.0,
        "packageHeight": 11.0,
        "packageWeight": 1000.0
    },
    "comment": "this is return api"
}'

Request Parameters:

Parameter	Data Type	Required	Description	Example
orderId	String	Yes	Unique identifier for the return order.	`return_wrap_qc_uat_23`
orderDate	String	Yes	Date on which the return order is created. Format: YYYY-MM-DD.	`2026-08-15`
is_qc_enabled	Boolean	Yes	Specifies whether Quality Check is enabled for the return order.	`true`
pickupLocation	Object	Yes	Contains customer details and address from where the return shipment will be picked up.	`{...}`
storeName	String	No	Name of the store associated with the return order.	`ABC Store`
return_reason_code	String	No	Code representing the reason for the return.	`DAMAGED`
deliveryAddress_name	String	No	Name associated with the delivery/return destination.	`RAPIDSHYP`
deliveryAddress	Object	Yes	Contains details of the destination address for the returned shipment.	`{...}`
orderItems	Array	Yes	List of products included in the return order.	`[{...}]`
packageDetails	Object	Yes	Contains package-level dimensions and weight.	`{...}`
comment	String	No	Additional comments or remarks associated with the return order.	`this is return api`

pickupLocation

Parameter	Data Type	Required	Description	Example
pickup_customer_name	String	Yes	First name of the customer from whom the return will be picked up.	`DO EPIC SHISP`
pickup_customer_last_name	String	No	Last name of the pickup customer.	`DO EPIC SHSIPP`
pickup_email	String	Yes	Email address of the pickup customer.	`avdhesh@omlogistics.com`
pickup_phone	String	Yes	Contact number of the pickup customer.	`9999999999`
pickup_address	String	Yes	Primary pickup address.	`abGGG`
pickup_address_2	String	No	Additional pickup address details.	`GG`
pickup_pincode	String	Yes	Pincode of the pickup location.	`110001`

deliveryAddress

Parameter	Data Type	Required	Description	Example
deliverylocation_name	String	Yes	Name of the delivery/return destination.	`RAPIDSHYP`
contact_name	String	Yes	Contact person at the destination.	`Abhinavqaqa`
delivery_address1	String	Yes	Primary delivery address.	`abxhA...`
delivery_address2	String	No	Additional delivery address information.	`abxAhd...`
pincode	String	Yes	Destination pincode.	`110001`
delivery_email	String	Yes	Email address of the destination contact.	`avdhesh.bhardwaj@omlogistics.co.in`
delivery_phone	String	Yes	Contact number of the destination.	`9999999999`

orderItems

Parameter	Data Type	Required	Description	Example
itemName	String	Yes	Name or identifier of the product.	`ARP1TEST0023`
sku	String	Yes	Stock Keeping Unit of the product.	`ARPTEST10023`
units	Integer	Yes	Number of units being returned.	`2`
unitPrice	Decimal	Yes	Price of one unit of the product.	`50.0`
tax	Decimal	No	Tax applicable to the product.	`0.0`
hsn	String	No	HSN code of the product.	`HSN456`
productLength	Decimal	No	Length of the product.	`11.0`
productBreadth	Decimal	No	Breadth of the product.	`12.0`
productHeight	Decimal	No	Height of the product.	`12.0`
productWeight	Decimal	No	Weight of the product.	`3.0`
brand	String	No	Brand name of the product.	`Nike`
serial_no	String	No	Serial number of the product, if applicable.	`223ww`
imei_no	String	No	IMEI number, if applicable.	`123456789012345`
images_name	Array[String]	Conditional	URL(s) of product images. Particularly relevant when QC is enabled.	`["https://..."]`
color	String	No	Product color.	`red`
size	String	No	Product size.	`L`

packageDetails

Parameter	Data Type	Required	Description	Example
packageLength	Decimal	Yes	Length of the return package.	`11.0`
packageBreadth	Decimal	Yes	Breadth of the return package.	`11.0`
packageHeight	Decimal	Yes	Height of the return package.	`11.0`
packageWeight	Decimal	Yes	Weight of the return package.	`1000.0`

Response:

{
    "status": "SUCCESS",
    "remark": "order created successfully.",
    "order_id": "return_wrap_qc_uat_26",
    "order_created": true,
    "shipment": [
        {
            "awb_generated": true,
            "pickup_generated": true,
            "shipment_id": "RS2609126",
            "awb_code": "RAPR2000000470",
            "courier_company_id": "",
            "parent_courier_name": "Ekart",
            "courier_name": "Ekart Reverse QC",
            "applied_weight": 1000,
            "routing_code": "NOI",
            "rto_routing_code": "NOI",
            "pickup_token_number": "",
            "pickup_scheduled_date": "12/09/2026",
            "total_value": 100,
            "shipment_items": [
                {
                    "name": "ARP1TEST0023",
                    "sku": "ARPTEST10023",
                    "units": 2,
                    "selling_price": 100
                }
            ]
        }
    ]
}

Basic Information

Curl:​

Request Parameters:​

pickupLocation​

deliveryAddress​

orderItems​

packageDetails​

Response:​