Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inbound | POST | /return/get/awb

Summary

This api will fetch the return order from omni based on return awb or return order id

Description

The

...

API takes awb number and transporter and returns all the return orders belonging to this awb number.

Request

Code Block
languagejson
{
  "awbNumber": "awb1",
  "transporter": "trans1"
}

Parameter Name

Data Type

Description

Mandatory

transporter

String

Courier partner name.

Yes

awbNumber

String

Courier tracking number.

Yes

Response

Code Block
languagejson
{
  "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
    }
  ]
}

...