Inbound | POST | /usp/return
Summary
EFS will call this API Post return order processing to notify OMS with return order processing detailsThis API is used by external fulfillment system to send Return order processing updates to Increff OMS system.
Description
This API will consume the return order processing details sent by External Fulfilment System (EFS) for any return order created in Increff OMS system.
This API will only get triggered after the return order is received and processed in Increff OMS system.
Request
| Code Block | ||
|---|---|---|
| ||
{
"returnOrderCode": "H893RUOT123",
"forwardOrderCode": "forwardOrder1",
"locationCode": "Wid234",
"channelName": "flipkart",
"awbNumber": "HYN402",
"transporter": "transporter"
"orderItems": [
{
"returnItemCode": "I10098",
"channelSkuCode": "100007542",
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"imageUrls": [
"https://increff.com/img.jpg",
"https://increff.com/img2.jpg"
]
}
]
} |
...
Parameter Name | Data Type | Description | Mandatory |
| String | Unique code used by the channel to identify the return order | yesYes |
| String | ForwardOrderCode associated with the return order | yesYes |
| String | Location code of the warehouse where the return order will be received. | yesYes |
| String | Channel name of the marketplace. | yesYes |
| String | Courier tracking number. | yesYes |
| String | Courier partner name. | yesYes |
| String | Unique code used by the channel to identify the return order item | yesYes |
| String | SKU code of return order item | yesYes |
| String | The reason due to which this return item has been marked QC fail | noNo |
| String | The qcStatus of the return Item. Possible values : PASS , FAIL | yesYes |
| String[] | It contains the list of urls of the images of the return items .It will only be populated in case that item has been marked as fail. | noNo |
Response
empty Empty body
HttpStatus : 200