Create a Return
Create Return
POST
http://wms.eshopbox.com/api/return
Create Return
POST
http://wms.eshopbox.com/api/return
This endpoint allows you to create a return.
Headers
Authentication
string
Bearer Token to grant access to the API
Request Body
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
Headers
Authentication
string
gakRs40qH7Re
Request Body
externalChannelID
string
SgbbKCSIxTmY
customerReturnNumber
string
ERfrCfmgtcWs
customerOrderNumber
string
SGnNbY11GfBa
pickup_type
string
RmZXWPcWST6K
refundAmount
string
ihtpwGi4tlwu
return_request_date
string
LzyBYrnxinHy
repaymentType
string
SZ3M3AaYkpaj
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
GBtskZMYH6RC
pickupAddress.customerName
string
vrOAoWubg1fx
pickupAddress.addressLine1
string
2QEyPQMNcNdt
pickupAddress.addressLine2
string
b7ZUOODAzH9t
pickupAddress.city
string
CpK8PWEaidLk
pickupAddress.state
string
W3I4tmNxRVru
pickupAddress.postalCode
string
4kdG18zTZKrT
pickupAddress.countryCode
string
zi8MzqotcZa7
pickupAddress.countryName
string
HtW7e2v8TFtL
pickupAddress.contactPhone
string
CMgPy9SVbNPI
pickupAddress.email
string
72VL5BDC7HCQ
items
array
GUGATDLaN8qg
Last updated
Was this helpful?