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
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
string
Response
Last updated