Create a Return

Create Return

POST http://wms.eshopbox.com/api/return

This endpoint allows you to create a return.

Headers

Name	Type	Description
Authentication	string	Bearer Token to grant access to the API

Request Body

Name	Type	Description
externalChannelID	string	Sales channel Name of a workspace
customerReturnNumber	string	Unique return number against a sales channel
customerOrderNumber	string	Unique order number against a sales channel
pickup_type	string	pickup type order return, default :"reverse"
refundAmount	string	Amount to be refunded on the return request
return_request_date	string	return request date time
repaymentType	string	refund mode
optional	string	if refund Mode bank, fill optional object
bankDetails	string	bank details object
bankDetails.beneficiaryName	string	account holder name
bankDetails.beneficiaryAccountNo	string	account number of a customer
bankDetails.beneficiaryIfscCode	string	Ifsc code of the bank
pickupAddress	object	Pickup address object of return items
pickupAddress.customerName	string	pickup customer name
pickupAddress.addressLine1	string	pickup address line
pickupAddress.addressLine2	string	pickup address line
pickupAddress.city	string	pickup address city
pickupAddress.state	string	pickup address state
pickupAddress.postalCode	string	pickup address pincode
pickupAddress.countryCode	string	pickup address country code
pickupAddress.countryName	string	pickup address country name
pickupAddress.contactPhone	string	pickup address contact number
pickupAddress.email	string	pickup address email address
items	array	return item object

200 Return successfully created.

{
    "externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
    "customerReturnNumber": "R4191129_1",
    "customerOrderNumber": "300975272",
    "pickupType": "reverse",
    "status": "CREATED",
    "pickupAddress": {
        "pickup_customerName": "Sam",
        "pickup_addressLine1": "Green Soul, reliable space",
        "pickup_addressLine2": "thane",
        "pickup_city": "Thane",
        "pickup_state": "Maharashtra",
        "pickup_postalCode": "421501",
        "pickup_countryCode": "IN",
        "pickup_countryName": "India",
        "pickup_contactPhone": "999999999",
        "pickup_email": "[e-mail]"
    },
    "dropAddress": {
        "drop_name": "Eshopbox Gurgaon (Sohna)",
        "drop_address": "MJ Logistics Private Limited, Seabird Marine Services Pvt Ltd,Village Babra Bakirpur, Pataudi Road Near Adani Logistic Park,  ICD Patli, Gurgaon, Haryana(122503)",
        "drop_pincode": "122503",
        "drop_city": "Gurgaon",
        "drop_country": "India",
        "drop_state": "Haryana"
    },
    "items": [
        {
           "lineItemSequenceNumber": 3022,
            "itemID": "5051039468601",
            "quantity": "1",
            "returnReason": "request for new",
            "orderItemID": "300975272-3736427",
            "productName": "Ellison Bay",
            "itemImage": "CA001CL95LVWCLRKS-90678.jpg",
            "returnFlag": "1",
            "lineItemTotal": 5499,
            "optional": {
                "image": null,
                "comments": null
            }
        }
    ]
}

curl --location --request POST 'http://wms.eshopbox.com/api/return' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--data-raw '{
	"customerReturnNumber":"50023235",
	"customerOrderNumber":"41004412",
	"externalChannelID":"PREPROD",
	"pickup_type": "reverse",
	"refundAmount": 2100,
	"isCOD": "0",
	"return_request_date": "2018-08-21 22:00:05",
	"repaymentType": "bank",
	"optional":{
		"bankDetails":{
			"beneficiaryName":"Sam",
			"beneficiaryAccountNo":"1234567899746",
			"beneficiaryIfscCode":"SIB0003246"
		}
	},
	"pickupAddress": {
        "customerName": "Sam",
        "addressLine1": "Green Soul, reliable space",
        "addressLine2": "thane",
        "city": "Thane",
        "state": "Maharashtra",
        "postalCode": "421501",
        "countryCode": "IN",
        "countryName": "India",
        "contactPhone": "999999999",
        "email": "[e-mail]"
    },
    "items":
    [
    	
    	{
    		"lineItemSequenceNumber": 3022,
            "itemID": "5051039468601",
            "quantity": "1",
            "returnReason": "request for new",
            "additionalInfo":{
            	"image":"www.image",
            	"comments":"bad item"
            },
            "itemImage":"www.realImage.com"
    	}
    	
	]
}'