Returns
After get delivered. An order can be returned by a customer's request. An order can be partially or fully returned as per customer required. Below parameters are required to generate a request.
Attributes
Sample Json
Attributes | Type | Description |
customerReturnNumber | string | A unique Number against a sales channel Return Request |
customerOrderNumber | string | Unique Number against Each Sales Channel |
externalChannelID | string | Sales Channel Name of a workspace |
pickup_type | string | pick up type of request must be " reverse " |
refundAmount | number | Amount to be refund for this particular return request |
isCOD | string | Type of order Enum : 0 , 1 (1 if order is cod,0 if order is prepaid) |
return_request_date | string | return request date time |
repaymentType | string | Type of pickup Enum:bank,originalPaymentMode |
optional | object | If repayment type is bank, Then optional detail must be filled |
optional.bankDetails | object | Bank details, used for refund process. |
bankDetails.beneficiaryName | string | beneficiaryName of account |
bankDetails.beneficiaryAccountNo | string | account number of customer |
bankDetails.beneficiaryIfscCode | string | ifsc code of bank |
pickupAddress | object | Pick up address of returned items |
pickupAddress.customerName | string | pickup customer Name |
pickupAddress.addressLine1 | string | pickup address |
pickupAddress.addressLine2 | string | pickup adress |
pickupAddress.city | string | pickup city |
pickupAddress.state | string | pickup state |
pickupAddress.postalCode | string | pickup state |
pickupAddress.countryCode | string | pickup country code |
pickupAddress.countryName | string | pickup country name |
pickupAddress.contactPhone | string | pickup contact number |
pickupAddress.email | string | pickup email address |
items | array[object] | The return items object |
{
"externalChannelID": "TATA CLIQ VELOCY KAPAS KRAFT",
"customerReturnNumber": "R4115823",
"customerOrderNumber": "300975272",
"pickup_type": "reverse",
"refundAmount": 0,
"return_request_date": "2019-12-11 21:04:59",
"repaymentType": "bank",
"optional":{
"bankDetails":{
"beneficiaryName":"John Doe",
"beneficiaryAccountNo":"1234567899999",
"beneficiaryIfscCode":"SIB0003222"
}
},
"pickupAddress": {
"customerName": "John Doe",
"addressLine1": "Kapas Kraft Apparels Limited",
"addressLine2": "Banglore",
"city": "bengluru",
"state": "Karnataka",
"postalCode": "560005",
"countryCode": "IN",
"countryName": "India",
"contactPhone": "9998889998",
"email": "[email protected]"
},
"items": [
{
"lineItemSequenceNumber": 81730,
"itemID": "5050409110942",
"quantity": 1,
"returnReason": "Not satisfied with size or fit",
"itemImage": "CA001CL95LVWCLRKS-90678.jpg",
"additionalInfo": {
"image": null,
"comments": null
}
}
]
}
The
Items
ObjectAttributes | Type | Description |
items[].lineItemSequenceNumber | string | incremental id of the item in created order |
items[].itemID | string | variant id of the item (seller SKU code) |
items[].quantity | string | quantity of the item |
items[].returnReason | string | reason for return |
items[].itemImage | string | item original image |
items[].additionalInfo | object | the additional item details |
The
additionalInfo
ObjectAttributes | Type | Description |
additionalInfo.image | string | delivered item image |
additionalInfo.comments | string | comments on image |
Enum: isCOD
Attribute | Description |
0 | created order must be Prepaid |
1 | created order must be COD |
Attribute | Description |
bank | if refund mode is bank, optional detail must be filled |
originalPaymentMode | if refund mode is OPM. optional details not required. |
Last modified 2yr ago