Return

Effortlessly generate Air Waybills (AWBs) for shipments and easily schedule reverse pickups for returned items, simplifying the return process for customers.

Create return

POST/api/v1/shipping/return

return Create API

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name

Required

Remarks

Type

channelId

No

The identifier for the sales channel

String

customerOrderId

Yes

The unique ID of the customer's order

String

shipmentId

Yes

The unique ID of the shipment

String

orderDate

No

The date and time when the order was placed. In case, not provided, current date and time will be considered as order date.

datetime (format: YYYY-MM-DD HH:MM)

isCOD

Yes

Indicates if the order is Cash on Delivery (COD). 1 if order is COD, 0 if order is prepaid

String

invoiceTotal

Yes

The total amount of the invoice. (inclusive of all the taxes)

number

shippingMode

No

The mode of shipping (e.g., Standard, Express)

string

invoice.number

Invoice number of the forward order

string

invoice.date

Invoice date of the forward order

date time

ewaybillNumber

No

E-way bill number

string

qcDetails.qc_color

No

Quality check color as mentioned on the product.

string

qcDetails.qc_brand

No

Quality check brand as mentioned on the product

string

qcDetails.qc_serial_no

No

Quality check serial number as mentioned on the product

string

qcDetails.qc_size

No

Quality check size as mentioned on the product

string

qcDetails.qc_product_name

No

Quality check product name as mentioned on the product

string

qcDetails.qc_product_image

No

Quality check product image

string

shippingAddress.locationCode

Yes

Location code of the delivery address. It is unique for each location. It is created as a location in your Eshopbox workspace.

string

qcDetails.qc_ean_barcode

No

Quality check EAN barcode as mentioned on the product

string

shippingAddress.locationName

No

Location name *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.companyName

No

Company name *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.contactPerson

No

Contact person *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.contactNumber

No

Contact number *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.addressLine1

No

Address line 1 *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.addressLine2

No

Address line 2 *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.city

No

City *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.state

No

State *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.pincode

No

Country *Mandatory if location code is blank or location is not created in Eshopbox.

string

shippingAddress.gstin

No

GSTIN *Mandatory if location code is blank or location is not created in Eshopbox.

string

items.itemID

Yes

Unique identifier for the item like sku, ESIN, EAN etc

string

items.productTitle

Yes

Title of the product

string

items.quantity

Yes

Quantity of the item to be returned

number

items.itemTotal

Yes

Total price for the item (inclusive of taxes)

number

items.hsn

No

HSN code for the item

string

items.mrp

No

Maximum Retail Price (MRP) of the item

number

items.taxPercentage

No

Tax percentage applied to the item

number

items.discount

No

Discount applied to the item when shipped

number

items.length

Yes

Length of the item (in cm)

number

items.breadth

Yes

Breadth of the item (in cm)

number

items.height

Yes

Height of the item (in cm)

number

items.weight

Yes

Weight of the item (in gram)

number

items.returnReason

Yes

Reason for return

string

items.productImageUrl

Yes

string

returnDimension.length

Yes

Length of the return package (in cm)

number

returnDimension.breadth

Yes

Breadth of the return package (in cm)

number

returnDimension.height

Yes

Height of the return package (in cm)

number

returnDimension.weight

Yes

Weight of the return package (in grams)

number

pickupLocation.customerName

No

Customer name

string

pickupLocation.addressLine1

Yes

Address line 1 of the pickup address

string

pickupLocation.addressLine2

No

Address line 2 of the pickup address

string

pickupLocation.city

No

City

string

pickupLocation.state

No

State

string

pickupLocation.pincode

Yes

Pincode

string

pickupLocation.country

Yes

Country

string

pickupLocation.contactPhone

Yes

Contact phone

string

pickupLocation.email

Yes

Email

string

Response

{
    "courierName": "Self",
    "trackingId": "874320208625",
    "shippingMode": "Express",
    "gstin": "36AAACC1206D2ZG",
    "transporterID": ""
}
curl --location -g 'https://wms.eshopbox.com/api/v1/shipping/return' \
--header 'Authorization: Bearer <Token>' \
--data-raw '{
    "channelId": "KAPAS KRAFT",
    "customerOrderId": "OD119208447831346000",
    "shipmentId":"2313ewqwre",
    "orderDate": "2020-02-29 15:39:11",
    "isCOD": true,
    "invoiceTotal": 4049.09,
    "shippingMode":"Standard",
    "invoice": {
        "number": "C00011323A000002",
        "date": "2023-06-02 15:39:11"
    },
    "ewaybillNumber":"",
    "shippingAddress": {
        "locationCode": "MCFL00395",
        "locationName": "TEST Warehouse",
        "companyName": "TEST",
        "contactPerson": "SAM",
        "contactNumber": "898898989",
        "addressLine1": "Khasra no 5/16/2,17, Near Subash Chowk, Sohana Road Village Behrampur",
        "addressLine2": "Khasra no 5/16/2,17, Near Subash Chowk",
        "city": "Gurgaon",
        "pincode":"121005",
        "state": "HARYANA",
        "country": "India",
        "gstin": "06AAFCM7888Q1ZE"
    },
    "items": [
        {
            "itemID": "DB9U03FMGWZ",
            "productTitle": "Pace Barnes",
            "quantity": 1,
            "itemTotal": 4049.09,
            "hsn":"122132",
            "mrp":2345.98,
            "discount":123,
            "taxPercentage":12.00,
            "returnReason": "TEST",
            "ean": "2342534", 
            "length": 12,
            "breadth": 18,
            "height": 23,
            "weight": 100,
            "qcDetails":{  
                "qc_color":"red",
                "qc_brand":"duke",
                "qc_serial_no":"212324235",
                "qc_ean_barcode":"sdsrewrt",
                "qc_size":"22",
                "qc_product_name":"TEST",
                "qc_product_image":"IMG.png",
                "qcParamsToCheck" : [
                    "check_price_tag",
                    "check_packaging_box",
                    "check_damaged",
                    "check_used"
                ]
            }
        }
    ],
    "returnDimension": {
        "length": 13.12,
        "breadth": 15.32,
        "height": 56.39,
        "weight": 201.23
    },
    "pickupLocation": {
         "customerName": "John Doe",
        "addressLine1": "Kapas Kraft Apparels Limited",
        "addressLine2": "Banglore",
        "city": "bengluru",
        "state": "Karnataka",
        "pincode": "560005",
        "country": "India",
        "contactPhone": "9998889998",
        "email": "johndoe@gmail.com"
    }
}'

Last updated