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	Mandatory	Type	Description
externalChannelID	No	string	Sales channel Name of a workspace
customerReturnNumber	Yes	string	Unique return number against a sales channel
assignCourier	Yes	Boolean	mark as true if return tracking id needs to be assigned, and false if return tracking id is not required
customerOrderNumber	Yes	string	Unique order number against a sales channel
pickup_type	Yes	string	pickup type order return, default :"reverse"
refundAmount	Yes	string	Amount to be refunded on the return request
isCOD	Yes	Boolean	Indicates if the order is Cash on Delivery (COD). true if order is COD, false if order is prepaid
return_request_date	Yes	string	return request date time
repaymentType	No	string	refund mode
pickupAddress		object	Pickup address object of return items
pickupAddress.customerName	Yes	string	pickup customer name
pickupAddress.addressLine1	Yes	string	pickup address line
pickupAddress.addressLine2	Yes	string	pickup address line
pickupAddress.city	Yes	string	pickup address city
pickupAddress.state	Yes	string	pickup address state
pickupAddress.postalCode	Yes	string	pickup address pincode
pickupAddress.countryCode	Yes	string	pickup address country code
pickupAddress.countryName	Yes	string	pickup address country name
pickupAddress.contactPhone	Yes	string	pickup address contact number
pickupAddress.email	Yes	string	pickup address email address
items		array	return item object
items.lineItemSequenceNumber	No	string	unique id of a item in client system
items.itemID	No	string	product availability identifier on a channel
items.SKU	Yes	string	SKU is a unique code that identifies characteristics of each product, source: client
items.quantity	Yes	number	quantity of the item to be returned
items.returnReason	No	string	reason for return
additionalInfo.image	No	string	image shared by the customer
additionalInfo.comment	No	string	remarks shared by end customer
itemImage	No	string	product image

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",
	"assignCourier": false
	"customerOrderNumber":"41004412",
	"externalChannelID":"PREPROD",
	"pickup_type": "reverse",
	"refundAmount": 2100,
	"isCOD": true,
	"return_request_date": "2023-08-21 22:00:05",
	"repaymentType": "bank",
		}
	},
	"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",
            "sku":"ZCWB01723-B382F036"
            "quantity": "1",
            "returnReason": "request for new",
            "additionalInfo":{
            	"image":"www.image.com",
            	"comments":"bad item"
            },
            "itemImage":"www.realImage.com"
    	}
    	
	]
}'