Update Returns API
- Prabal Pandit
- Raghav Mehta
Inbound | POST | /return/update-return-order
Summary
This API is used to update the return order details.
Description
This API is used to update the status, tracking code, transporter and expected date of return order
Request
{
"returnOrderCode":"retO1",
"locationCode":"loc1",
"transporter":"trans1",
"trackingCode":"awb1",
"returnOrderStatus":"in_transit",
"expectedDate":"2022-10-30T20:22:28.000+00:00",
"returnOrderAttributes": {
"attribute1": "string",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string"
},
"returnOrderItemAttributes": [
{
"attribute1": "string",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string",
"channelSkuCode": "string", // not null
"orderItemCode": "string" // not null
}
]
}
Parameter Name | Data Type | Description | Mandatory |
| String | Unique identifier provided by the channel for the return order being created. | yes |
| String | Location code of the warehouse where the return order will be received. | yes |
| String | Courier partner name. | no |
| String | Courier tracking number. | no |
| String | The status of the return order on channel | no |
| String | The expected delivery date of the return order | no |
| Object | Custom attributes of the forward order | no |
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | no |
| String | Custom attribute 2 | no |
| String | Custom attribute 3 | no |
| String | Custom attribute 4 | no |
| String | Custom attribute 5 | no |
| String | Custom attribute 6 | no |
| String | Custom attribute 7 | no |
| String | Custom attribute 8 | no |
| String | Custom attribute 9 | no |
| String | Custom attribute 10 | no |
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| Object[] | Custom attributes of order item | no |
| Object | List of attributes for the order item | no |
| String | Custom attribute 1 | no |
| String | Custom attribute 2 | no |
| String | Custom attribute 3 | no |
| String | Custom attribute 4 | no |
| String | Custom attribute 5 | no |
| String | Custom attribute 6 | no |
| String | Custom attribute 7 | no |
| String | Custom attribute 8 | no |
| String | Custom attribute 9 | no |
| String | Custom attribute 10 | no |
| Object | meta data fields as an object which is to be parsed at the channel’s end | no |
| Object | channelSkuCode which is returned | no |
| Object | return order item code of the item returned | no |
Response
Empty Body
HttpStatus : 200