This API is used to update the return order details.
This API is used to update the status, tracking code, transporter and expected date of return order
{
"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"
},
"returnOrderItemAttributesList": [
{
"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 |
|---|---|---|---|
returnOrderCode |
String | Unique identifier provided by the channel for the return order being created. | yes |
locationCode |
String | Location code of the warehouse where the return order will be received. | yes |
transporter |
String | Courier partner name. | no |
trackingCode |
String | Courier tracking number. | no |
returnOrderStatus |
String | The status of the return order on channel | no |
expectedDate |
String | The expected delivery date of the return order | no |
returnOrderAttributes |
Object | Custom attributes of the forward order | no |
returnOrderAttributes.attribute1 |
String | Custom attribute 1 | no |
returnOrderAttributes.attribute2 |
String | Custom attribute 2 | no |
returnOrderAttributes.attribute2 |
String | Custom attribute 2 | no |
returnOrderAttributes.attribute3 |
String | Custom attribute 3 | no |
returnOrderAttributes.attribute4 |
String | Custom attribute 4 | no |
returnOrderAttributes.attribute5 |
String | Custom attribute 5 | no |
returnOrderAttributes.attribute6 |
String | Custom attribute 6 | no |
returnOrderAttributes.attribute7 |
String | Custom attribute 7 | no |
returnOrderAttributes.attribute8 |
String | Custom attribute 8 | no |
returnOrderAttributes.attribute9 |
String | Custom attribute 9 | no |
returnOrderAttributes.attribute10 |
String | Custom attribute 10 | no |
returnOrderAttributes.channelMetaData |
Object | meta data fields as an object which is to be parsed at the channel’s end | no |
returnOrderItemAttributesList |
Object[] | Custom attributes of order item | no |
returnOrderItemAttributesList.attribute1 |
String | Custom attribute 1 | no |
returnOrderItemAttributesList.attribute2 |
String | Custom attribute 2 | no |
returnOrderItemAttributesList.attribute3 |
String | Custom attribute 3 | no |
returnOrderItemAttributesList.attribute4 |
String | Custom attribute 4 | no |
returnOrderItemAttributesList.attribute5 |
String | Custom attribute 5 | no |
returnOrderItemAttributesList.attribute6 |
String | Custom attribute 6 | no |
returnOrderItemAttributesList.attribute7 |
String | Custom attribute 7 | no |
returnOrderItemAttributesList.attribute8 |
String | Custom attribute 8 | no |
returnOrderItemAttributesList.attribute9 |
String | Custom attribute 9 | no |
returnOrderItemAttributesList.attribute10 |
String | Custom attribute 10 | no |
returnOrderItemAttributesList.channelMetaData |
String | meta data fields as an object which is to be parsed at the channel’s end | no |
returnOrderItemAttributesList.channelSkuCode |
String | channelSkuCode which is returned | yes |
returnOrderItemAttributesList.orderItemCode |
String | return order item code of the item returned | yes |
Empty Body
HttpStatus : 200