Push Return Order Events to EFS (Beta)

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.
Possible Event values:
- RETURN_ORDER_CREATE: When a return order is created, this event will be hit.
- RETURN_ORDER_UPDATE: Whenever an update in the return order like AWB and Transprter takes place, this event will be triggered.
- RETURN_ORDER_CANCEL: This event will be triggered when the return order is fully cancelled.
- RETURN_ORDER_PARTIAL_CANCEL: This event will be triggered when the return order is partially cancelled.
- RETURN_ORDER_COMPLETE: This event will be triggered when the return order processing is completed.
This API will be triggered at a certain frequency by Increff OMS.

Request

{
    "forwardOrderCode": "1651836",
    "returnOrderCode": "000213401",
    "locationCode": "3082",
    "channelName": "CROCSIN",
    "eventType": "RETURN_ORDER_CREATE",
    "returnOrderTime": "2024-06-06T15:14:02.000+00:00",
    "orderItems": [
        {
            "returnItemCode": "218333",
            "reason": "SIZE MISMATCH",
            "channelSkuCode": "205182-0DD-M10W12",
            "status": "PROCESSED",
            "isBundled": null,
            "childItemCodes": [
                {
                    "globalSkuId": 1000004230,
                    "channelSkuCode": "205182-0DD-CHILD",
                    "itemCode": "child-item-1"
                }
            ],
            "returnOrderItemAttributes": {
                "attribute1": "string",
                "attribute2": "string",
                "attribute3": "string",
                "attribute4": "string",
                "attribute5": "string",
                "attribute6": "string",
                "attribute7": "string",
                "attribute8": "string",
                "attribute9": "string",
                "attribute10": "string",
                "channelMetadata": "string",
                "channelMetadataMap": { "key1": "value1", "key2": "value2" }
            }
        },
        {
            "returnItemCode": "218334",
            "reason": "SIZE MISMATCH",
            "channelSkuCode": "205182-0DD-M10W11",
            "status": "PROCESSED",
            "isBundled": null,
            "returnOrderItemAttributes": {
                "attribute1": "string",
                "attribute2": "string",
                "attribute3": "string",
                "attribute4": "string",
                "attribute5": "string",
                "attribute6": "string",
                "attribute7": "string",
                "attribute8": "string",
                "attribute9": "string",
                "attribute10": "string",
                "channelMetadata": "string",
                "channelMetadataMap": { "key1": "value1", "key2": "value2" }
            }
        }
    ],
    "channelReturnOrderStatus": "OUT_FOR_PICKUP",
    "expectedDate": "2024-08-22T08:00:08.000+00:00",
    "isUploaded": false,
    "orderType": "CUSTOMER_RETURN",
    "awbNumber": "81732657871",
    "transporter": "Blue Dart Reverse QC",
    "status": "COMPLETED",
    "returnOrderAttributes": {
        "attribute1": "string",
        "attribute2": "string",
        "attribute3": "string",
        "attribute4": "string",
        "attribute5": "string",
        "attribute6": "string",
        "attribute7": "string",
        "attribute8": "string",
        "attribute9": "string",
        "attribute10": "string",
        "channelMetadata": "string",
        "channelMetadataMap": { "key1": "value1", "key2": "value2" }
    },
    "receivedReturnOrderItems": [
        {
            "itemCode": "test_fa4021adecb5",
            "channelSkuCode": "test_d49e2677cc19",
            "returnReason": "test_41a6eadcc897",
            "isBundled": false,
            "returnOrderItemStatus": "test_3dd28f1f26ee",
            "returnOrderItemAttributes": {
                "attribute1": "test_f734a2cf4d49",
                "attribute2": "test_7dc08e792ccd",
                "attribute3": "test_776e309d9190",
                "attribute4": "test_cb3f6d2a1bec",
                "attribute5": "test_24b7db72a926",
                "attribute6": "test_3ffd7c7482b5",
                "attribute7": "test_0d22e0904884",
                "attribute8": "test_c9492852b829",
                "attribute9": "test_57ce5b5f93d0",
                "attribute10": "test_4a9eac4cc7b9",
                "channelMetadata": "test_25bb0445f896",
                "channelMetadataMap": { "key1": "value1", "key2": "value2" }
            },
            "qcReason": "test_7ca904a886d8",
            "qcStatus": "FAIL"
        }
    ],
    "virtualSkuDefinitions": [
        {
            "virtualParentChannelSkuId": "string",
            "virtualParentBarcode": "string",
            "virtualParentClientSkuCode": "string",
            "childSkus": [
                {
                    "channelSkuCode": "string",
                    "qty": 0,
                    "barcode": "string",
                    "clientSkuCode": "string"
                }
            ]
        }
    ],
    "bundledSkuDefinitions": [
        {
            "bundledParentChannelSkuId": "string",
            "bundledParentBarcode": "string",
            "bundledParentClientSkuCode": "string",
            "childSkus": [
                {
                    "channelSkuCode": "string",
                    "qty": 0,
                    "barcode": "string",
                    "clientSkuCode": "string"
                }
            ]
        }
    ]
}

Parameter Name	Data Type	Description	Mandatory
`forwardOrderCode`	String	Forward order code for which return order is being created.	Yes
`eventType`	String	Possible values : `RETURN_ORDER_CREATE`, `RETURN_ORDER_UPDATE`, `RETURN_ORDER_CANCEL`, `RETURN_ORDER_PARTIAL_CANCEL`, `RETURN_ORDER_COMPLETE`	Yes
`returnOrderCode`	String	Unique identifier provided by the channel for the return order being created.	Yes
`locationCode`	String	Location code of the warehouse where the return order will be received.	Yes
`channelName`	String	Channel name of the marketplace.	Yes
`returnOrderTime`	String	Time at which return order got placed by customer	No
`channelReturnOrderStatus`	String	Return Order status coming from Logistics management system	No
`status`	String	Status of the return: `CREATED`, `CANCELLED`, `COMPLETED`	No
`expectedDate`	ZonedDateTime	Date in case client is using Return Plug in like Returns Prime	No
`isUploaded`	Boolean	whether the return is uploaded in omni or created though api.	Yes
`orderType`	String	Type of return. Possible values → `SELF_SHIP`, `CUSTOMER_RETURN`, `RETURN_TO_ORIGIN`	Yes
`awbNumber`	String	Courier tracking number.	Yes
`transporter`	String	Courier partner name.	Yes
`orderItems`	Object[]	Array of order items, order items represent each line of return order.	Yes
`orderItems.returnItemCode`	String	Unique identifier provided by the channel for the return order item.	Yes
`orderItems.reason`	String	Reason for return as given by the customer.	Yes
`orderItems.channelSkuCode`	String	SKU code for return order item.	Yes
`orderItems.status`	String	Status of the return order item: `CREATED`, `PROCESSED`, `MISSING`, `CANCELLED`, `PARTIAL_MISSING_COMBO`	No
`orderItems.isBundled`	Boolean	Defines if the item is a bundled SKU or not	No
`orderItems.childItemCodes`	Object[]	List of child item metadata for bundled SKUs	No
`orderItems.childItemCodes.globalSkuId`	Long	Global SKU id of the child SKU	No
`orderItems.childItemCodes.channelSkuCode`	String	Channel SKU code of the child SKU	No
`orderItems.childItemCodes.itemCode`	String	Item code of the child SKU	No
`orderItems.returnOrderItemAttributes`	Object	Custom attributes of order item	No
`orderItems.returnOrderItemAttributes.attribute1`	String	Custom attribute 1	No
`orderItems.returnOrderItemAttributes.attribute2`	String	Custom attribute 2	No
`orderItems.returnOrderItemAttributes.attribute3`	String	Custom attribute 3	No
`orderItems.returnOrderItemAttributes.attribute4`	String	Custom attribute 4	No
`orderItems.returnOrderItemAttributes.attribute5`	String	Custom attribute 5	No
`orderItems.returnOrderItemAttributes.attribute6`	String	Custom attribute 6	No
`orderItems.returnOrderItemAttributes.attribute7`	String	Custom attribute 7	No
`orderItems.returnOrderItemAttributes.attribute8`	String	Custom attribute 8	No
`orderItems.returnOrderItemAttributes.attribute9`	String	Custom attribute 9	No
`orderItems.returnOrderItemAttributes.attribute10`	String	Custom attribute 10	No
`orderItems.returnOrderItemAttributes.channelMetadata`	String	meta data fields as a string which is to be parsed at the channel's end	No
`orderItems.returnOrderItemAttributes.channelMetadataMap`	Map<String, String>	Key-value pairs of additional channel metadata for the order item	No
`receivedReturnOrderItems`	Object[]	Contains data for items which are received in warehouse	No
`receivedReturnOrderItems.itemCode`	String	Item code of the received return item	Yes
`receivedReturnOrderItems.channelSkuCode`	String	Channel SKU code of the received item	Yes
`receivedReturnOrderItems.returnReason`	String	Reason for the return	No
`receivedReturnOrderItems.isBundled`	Boolean	Whether the received item is a bundled SKU	No
`receivedReturnOrderItems.returnOrderItemStatus`	String	Status of the received item. Expected values: `CREATED, PROCESSED, MISSING, PARTIAL_MISSING_COMBO, CANCELLED`	Yes
`receivedReturnOrderItems.returnOrderItemAttributes`	Object	Custom attributes of the received item	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute1`	String	Custom attribute 1	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute2`	String	Custom attribute 2	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute3`	String	Custom attribute 3	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute4`	String	Custom attribute 4	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute5`	String	Custom attribute 5	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute6`	String	Custom attribute 6	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute7`	String	Custom attribute 7	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute8`	String	Custom attribute 8	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute9`	String	Custom attribute 9	No
`receivedReturnOrderItems.returnOrderItemAttributes.attribute10`	String	Custom attribute 10	No
`receivedReturnOrderItems.returnOrderItemAttributes.channelMetadata`	String	meta data fields as a string which is to be parsed at the channel's end	No
`receivedReturnOrderItems.returnOrderItemAttributes.channelMetadataMap`	Map<String, String>	Key-value pairs of additional channel metadata	No
`receivedReturnOrderItems.qcReason`	String	qc reason for the received item	No
`receivedReturnOrderItems.qcStatus`	String	qc status. Possible values: `PASS, FAIL`	No
`returnOrderAttributes`	Object	Custom attributes of the return order	No
`returnOrderAttributes.attribute1`	String	Custom attribute 1	No
`returnOrderAttributes.attribute2`	String	Custom attribute 2	No
`returnOrderAttributes.attribute3`	String	Custom attribute 3	No
`returnOrderAttributes.attribute4`	String	Custom attribute 4	No
`returnOrderAttributes.attribute5`	String	Custom attribute 5	No
`returnOrderAttributes.attribute6`	String	Custom attribute 6	No
`returnOrderAttributes.attribute7`	String	Custom attribute 7	No
`returnOrderAttributes.attribute8`	String	Custom attribute 8	No
`returnOrderAttributes.attribute9`	String	Custom attribute 9	No
`returnOrderAttributes.attribute10`	String	Custom attribute 10	No
`returnOrderAttributes.channelMetadata`	Object	Meta data fields as an object which is to be parsed at the channel's end	No
`returnOrderAttributes.channelMetadataMap`	Map<String, String>	Key-value pairs of additional channel metadata for the return order	No
`virtualSkuDefinitions`	Object[]	List of virtual SKU definitions	No
`virtualSkuDefinitions.virtualParentChannelSkuId`	String	Channel SKU ID of the virtual parent	Yes
`virtualSkuDefinitions.virtualParentBarcode`	String	Barcode of the virtual parent SKU	No
`virtualSkuDefinitions.virtualParentClientSkuCode`	String	Client SKU code of the virtual parent	No
`virtualSkuDefinitions.childSkus`	Object[]	List of child SKUs under the virtual SKU	No
`virtualSkuDefinitions.childSkus.channelSkuCode`	String	Channel SKU code of the child SKU	Yes
`virtualSkuDefinitions.childSkus.qty`	Integer	Quantity of the child SKU	No
`virtualSkuDefinitions.childSkus.barcode`	String	Barcode of the child SKU	No
`virtualSkuDefinitions.childSkus.clientSkuCode`	String	Client SKU code of the child SKU	No
`bundledSkuDefinitions`	Object[]	List of bundled SKU definitions	No
`bundledSkuDefinitions.bundledParentChannelSkuId`	String	Channel SKU ID of the bundled parent	Yes
`bundledSkuDefinitions.bundledParentBarcode`	String	Barcode of the bundled parent SKU	No
`bundledSkuDefinitions.bundledParentClientSkuCode`	String	Client SKU code of the bundled parent	No
`bundledSkuDefinitions.childSkus`	Object[]	List of child SKUs under the bundled SKU	Yes
`bundledSkuDefinitions.childSkus.channelSkuCode`	String	Channel SKU code of the child SKU	Yes
`bundledSkuDefinitions.childSkus.qty`	Integer	Quantity of the child SKU	No
`bundledSkuDefinitions.childSkus.barcode`	String	Barcode of the child SKU	No
`bundledSkuDefinitions.childSkus.clientSkuCode`	String	Client SKU code of the child SKU	No

Response Body

Empty Body

HttpStatus : 200