Push Return Order Cancellation to EFS

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.
This API will be triggered at a certain frequency by Increff OMS at RETURN_ORDER_CANCELevent.

Request

{
  "forwardOrderCode": "1651836",
  "returnOrderCode": "000213401",
  "locationCode": "3082",
  "channelName": "CROCSIN",
  "eventType": "RETURN_ORDER_CANCEL",
  "returnOrderTime": "2024-06-06T15:14:02.000+00:00",
  "orderItems": [
    {
      "returnItemCode": "218333",
      "reason": "",
      "channelSkuCode": "205182-0DD-M10W12",
      "status": "CANCELLED",
      "isBundled": null
    },
    {
      "returnItemCode": "218333",
      "reason": "",
      "channelSkuCode": "205182-0DD-M10W12",
      "status": "CANCELLED",
      "isBundled": null
    }
  ],
  "orderType": "CUSTOMER_RETURN",
  "awbNumber": "81732657871",
  "transporter": "Blue Dart Reverse QC",
  "status": "CANCELLED",
  "virtualSkuDefinitions": null,
  "bundledSkuDefinitions": null
}

Parameter Name	Data Type	Description	Mandatory
`forwardOrderCode`	String	Forward order code for which return order is being created.	Yes
`eventType`	String	`RETURN_ORDER_CANCEL`	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
`status`	String	status of the return CREATE/CANCELLED/COMPLETED	Mo
`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 CREATE/CANCELLED/COMPLETED	No
`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

Response

Empty Body

HttpStatus : 200