Push Return Order Events to EFS (Beta)

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.itemCode

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