Versions Compared

Key

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

Inbound | POST | /usp/return

Summary

This API is used by external fulfillment system to send Return order processing updates to Increff OMS system.

Description

  • This API will consume the return order processing details sent by External Fulfilment System (EFS) for any return order created in Increff OMS system.

  • This API will only get triggered after the return order is received and processed in Increff OMS system.

Request

Code Block
languagejson
{
    "returnOrderCode": "H893RUOT123",
    "forwardOrderCode": "forwardOrder1",
    "locationCode": "Wid234",
    "channelName": "flipkart",
    "awbNumber": "HYN402",
    "transporter": "transporter"
    "orderItems": [
        {
            "returnItemCode": "I10098",
            "channelSkuCode": "100007542",
            "qcStatus": "FAIL",
            "qcReason": "DAMAGED",
            "imageUrls": [
                "https://increff.com/img.jpg",
                "https://increff.com/img2.jpg"
            ]
        }
    ]
}

...

Parameter Name

Data Type

Description

Mandatory

returnOrderCode

String

Unique code used by the channel to identify the return order

Yes

forwardOrderCode

String

ForwardOrderCode associated with the return order

Yes

locationCode

String

Location code of the warehouse where the return order will be received.

Yes

channelName

String

Channel name of the marketplace.

Yes

awbNumber

String

Courier tracking number.

Yes

transporter

String

Courier partner name.

Yes

orderItems.returnItemCode

String

Unique code used by the channel to identify the return order item

Yes

orderItems.channelSkuCode

String

SKU code of return order item

Yes

orderItems.qcReason

String

The reason due to which this return item has been marked QC fail

No

orderItems.qcStatus

String

The qcStatus of the return Item.

Possible values :

PASS , FAIL

Yes

orderItems.imageUrls

String[]

It contains the list of urls of the images of the return items .It will only be populated in case that item has been marked as fail.

No

 

Response

Empty body

HttpStatus : 200