Return Order Processing Update

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

{
      "channelName": "Myntra",
      "locationCode": "l123",
      "transporter": "BlueDart",
      "returnOrderCode": "RET-001",
      "forwardOrderCode": "H19304030001",
      "awbNumber": "AWB123456789",
      "orderItems": [
          {
              "returnItemCode": "RET-ITEM-001",
              "channelSkuCode": "100000789702",
              "qcStatus": "PASS",
              "qcReason": "Item in good condition",
              "imageUrls": [
                  "<https://mybrand.com/return-image1.jpg>",
                  "<https://mybrand.com/return-image2.jpg>"
              ],
              "batchId": 12345,
              "clientSkuId": "SKU001",
              "externalBatchId": "EXTBATCH001",
              "mfgDate": "2024-01-01T00:00:00.000+05:30",
              "expiryDate": "2025-12-31T23:59:59.000+05:30"
          },
          {
              "returnItemCode": "RET-ITEM-002",
              "channelSkuCode": "100000789703",
              "qcStatus": "FAIL",
              "qcReason": "Item damaged",
              "imageUrls": [
                  "<https://mybrand.com/damaged-image1.jpg>"
              ],
              "batchId": null,
              "clientSkuId": null,
              "externalBatchId": null,
              "mfgDate": null,
              "expiryDate": null
          }
      ]
  }

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
`orderItems[].batchId`	Integer	Batch ID	No
`orderItems[].clientSkuId`	String	Client SKU ID	No
`orderItems[].externalBatchId`	String	External batch ID	No
`orderItems[].mfgDate`	ZonedDateTime	Manufacturing date	No
`orderItems[].expiryDate`	ZonedDateTime	Expiry date	No

Response

Empty body

HttpStatus : 200