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",
    "orderCustomAttributes": {
        "attribute1": "GiftCombo",
        "attribute10": "RoutingAllowed",
        "attribute2": "LoopRequired",
        "attribute3": "CustomisedSLA",
        "attribute4": "SameDayDelivery",
        "attribute5": "Dummy-attribute-1",
        "attribute6": "Dummy-attribute-2",
        "attribute7": "Dummy-attribute-3",
        "attribute8": "Dummy-attribute-4",
        "attribute9": "Dummy-attribute-5",
        "channelMetadata": "string",
        "currency": "string"
    },
    "orderItemCustomAttributes": [
        {
            "barcode": "string",
            "channelSkuCode": "string",
            "clientSkuCode": "string",
            "orderItemCode": "string",
            "orderItemCustomAttributes": {
                "attribute1": "CustomisedProduct",
                "attribute10": "HandleWithCareProduct",
                "attribute2": "Dummy-attribute-1",
                "attribute3": "Dummy-attribute-2",
                "attribute4": "Dummy-attribute-3",
                "attribute5": "Dummy-attribute-4",
                "attribute6": "Dummy-attribute-5",
                "attribute7": "Dummy-attribute-6",
                "attribute8": "Dummy-attribute-7",
                "attribute9": "Dummy-attribute-8",
                "channelMetadata": "string"
            }
        }
    ],
    "orderItems": [
        {
            "returnItemCode": "218333",
            "reason": "SIZE MISMATCH",
            "channelSkuCode": "205182-0DD-M10W12",
            "status": "PROCESSED",
            "isBundled": null,
            "returnOrderItemAttributes": {
                "attribute1": "string",
                "attribute10": "string",
                "attribute2": "string",
                "attribute3": "string",
                "attribute4": "string",
                "attribute5": "string",
                "attribute6": "string",
                "attribute7": "string",
                "attribute8": "string",
                "attribute9": "string",
                "channelMetadata": "string"
            }
        },
        {
            "returnItemCode": "218334",
            "reason": "SIZE MISMATCH",
            "channelSkuCode": "205182-0DD-M10W11",
            "status": "PROCESSED",
            "isBundled": null,
            "returnOrderItemAttributes": {
                "attribute1": "string",
                "attribute10": "string",
                "attribute2": "string",
                "attribute3": "string",
                "attribute4": "string",
                "attribute5": "string",
                "attribute6": "string",
                "attribute7": "string",
                "attribute8": "string",
                "attribute9": "string",
                "channelMetadata": "string"
            }
        }
    ],
    "channelReturnOrderStatus": "OUT_FOR_PICKUP",
    "expectedDate": 1724311208,
    "isUploaded": "false",
    "orderType": "CUSTOMER_RETURN",
    "awbNumber": "81732657871",
    "transporter": "Blue Dart Reverse QC",
    "status": "COMPLETED",
    "returnOrderAttributes": {
        "attribute1": "string",
        "attribute10": "string",
        "attribute2": "string",
        "attribute3": "string",
        "attribute4": "string",
        "attribute5": "string",
        "attribute6": "string",
        "attribute7": "string",
        "attribute8": "string",
        "attribute9": "string",
        "channelMetadata": "string"
    },
    "receivedReturnOrderItems": [
        {
            "returnItemCode": "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"
            },
            "qcReason": "test_7ca904a886d8",
            "qcStatus": "FAIL"
        }
    ]
}

Column	Column	Column	Column
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`: 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.	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
`orderCustomAttributes`	Object[]	Custom attributes stored for Forward order	No
`orderItemCustomAttributes`	Object[]	Custom attributes stored for Forward order items	No
`channelReturnOrderStatus`	String	Return Order status coming from Logistics management system	No
`status`	String	Status of the return
• `CREATED`
• `CANCELLED`
• `COMPLETED`	No
`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:
• `CREATED`
• `PROCESSED`
• `MISSING`
• `CANCELLED`
• `PARTIAL_MISSING_COMBO`	No
`orderItems.isBundled`	String	Defines if the item is a bundled SKU or not	No
`orderItems.cancelledQuantity`	Integer	Quantity cancelled in forward order	No
`orderItems.channelDiscount`	Double	Channel Discount provided for the item	No
`orderItems.returnOrderItemAttributes`	Object[]	Custom attributes of order item	No
`orderItems.returnOrderItemAttributes`.`orderItemCustomAttributes`	Object	List of attributes for the 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`	Object	meta data fields as an object which is to be parsed at the channel’s end	No
`channelReturnOrderStatus`	String	Status for return shipment received from logistics management system	No
`expectedDate`	Zoned Date Time	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
`returnOrderAttributes`	Object []	Custom attributes of the forward order	no
`returnOrderAttributes.attribute1`	String	Custom attribute 1	no
`returnOrderAttributes.attribute2`	String	Custom attribute 2	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
`receivedReturnOrderItems`	Object	Contains data for items which are received in warehouse	No

Response Body

Empty Body

HttpStatus : 200