Outbound | POST | {Client’s URL}
Summary
This API is used to pass on the return order expectation coming from Marketplaces to External Fulfilment Systems.
Description
This API will push the return order expectations coming from Marketplace APIs to External Fulfillment system.
This API will be triggered at a certain frequency by Increff OMS at
RETURN_ORDER_CREATEevent.
Request
| Code Block | ||
|---|---|---|
| ||
{
"forwardOrderCode": "108",
"returnOrderCode": "100078",
"locationCode": "Wid234",
"channelName": "flipkart",
"eventType": "RETURN_ORDER_CREATE",
"returnOrderTime": "2020-10-16T20:22:28.000+05:30",
"orderItems": [
{
"returnItemCode": "I10098",
"reason": "Different Size",
"channelSkuCode": "10007345"
}
],
"orderType": "CUSTOMER_RETURN",
"awbNumber": "HYN402",
"transporter": "transporter"
} |
...
Parameter Name | Data Type | Description | Mandatory |
| String | Forward order code for which return order is being created. | Yes |
| String | Possible values : { | Yes |
| 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 | Channel name of the marketplace. | Yes |
| String | Time at which return order got placed by customer | No |
| Object[] | Array of order items, order items represent each line of return order. | Yes |
| String | Unique identifier provided by the channel for the return order item. | Yes |
| String | Reason for return as given by the customer. | Yes |
| String | SKU code for return order item. | Yes |
| String | Type of return. Possible values - SELF_SHIP,CUSTOMER_RETURN,RETURN_TO_ORIGIN | Yes |
| String | Courier tracking number. | Yes |
| String | Courier partner name. | Yes |
Response
Empty Body
HttpStatus : 200