Inbound | POST | /return/get/awb

Summary

This API will fetch the return order from Increff system based on return AWB or Return Order Identifier passed in the API request

Description

This API will fetch the return order from Increff system based on return AWB or Return Order Identifier passed in the API request

Request

{
  "awbNumber": "awb1",
  "transporter": "trans1"
}
Parameter Name Data Type Description Mandatory
transporter String Courier partner name. Yes
awbNumber String Courier tracking number. Yes

Response

{
  "returnOrderDetailsList": [
    {
      "orderCode": "100",
      "returnOrderCode": "100078",
      "trackingCode": "awb1",
      "transporter": "trans1",
      "locationCode": "Wid234",
      "returnOrderType": "RETURN_TO_ORIGIN",
      "returnLineItems": [
        {
          "channelReturnItemCode": "I10098",
          "subOrderCode": "1",
          "channelSkuCode": "10007345",
          "reasonForReturn": "Different Size",
          "price": 100.00
        }
      ],
      "channelReturnOrderStatus": "CREATED",
      "omniReturnOrderStatus": "CREATED",
      "expectedDate": "2024-04-03T15:12:10.719+05:30",
      "isSyncedToOms": false
    }
  ]
}
Parameter Name Data Type Description Mandatory
returnOrderDetailsList array[] list of all the return orders having requested awb number Yes
returnOrderDetailsList.orderCode String Forward order code corresponding to which this return order belongs Yes
returnOrderDetailsList.returnOrderCode String Unique identifier provided by the channel for the existing return order for which item is being added. Yes
returnOrderDetailsList.trackingCode String Courier tracking number. Yes
returnOrderDetailsList.locationCode String Location code of the warehouse where the return order will be received. Yes
returnOrderDetailsList.returnOrderType String The type of return is this order.
Possible values- RETURN_TO_ORIGIN,CUSTOMER_RETURN,SELF_SHIP Yes
returnOrderDetailsList.returnLineItems Array[] liist of all the return items of a particular return order yes
returnOrderDetailsList.returnLineItems.channelReturnItemCode String Unique identifier provided by the channel for the return order item. Yes
returnOrderDetailsList.returnLineItems.subOrderCode String unique identifier for each suborder after the split Yes
returnOrderDetailsList.returnLineItems.channelSkuCode String SKU code for return order item. Yes
returnOrderDetailsList.returnLineItems.reasonForReturn String Reason for return as given by the customer. No
returnOrderDetailsList.returnLineItems.price Double Price of the product No
returnOrderDetailsList.channelReturnOrderStatus String status of return order on channel No
returnOrderDetailsList.omniReturnOrderStatus String status of return order in omni No
returnOrderDetailsList.expectedDate Date The expected delivery date of the return order Yes
returnOrderDetailsList.isSyncedToOms boolean is return order synced to omni or not No

HTTP status

200