Page Comparison

Parameter Name

Data Type

Description

Mandatory

forwardOrderCode

String

Forward Order Code

yes

forwardAwb

String

Forward AWB for the order. If the notification is of forward order, this field would be present.

Conditional yes

notificationType

String

The type of notification that is being sent. The possible values are listed in the Notification Type sectionbelow.

yes

returnOrderInfo

Object

Return Order Information. Will be present if the notification type is a return type(AWB_GENERATED, RETURN_PICKUP, RTO etc.)

Conditional yes

returnOrderInfo.returnOrderId

String

Return Order Id

Conditional yes

returnOrderInfo.returnAwb

String

Return Awb

Conditional yes

returnOrderInfo.transporter

String

Courier for the return order

Conditional yes

returnOrderInfo.returnOrderTime

Date

Return Order Time

Conditional yes

logisticAggregatorInfo

Object

This contains the custom fields sent by Clickpost/Shiprocket

yes

logisticAggregatorInfo.logisticAggregatorType

String

Logistic Aggregator type. Can be CLICKPOST or SHIPROCKET

yes

logisticAggregatorInfo.logisticAggregatorMetaData

Object

Map of extra information that are passed to us by logistic aggregators. Example - Account Code, Security Key etc. in Clickpost’s case

yes

warehouseCode

String

Warehouse Code for the forward/return order. If the shipping label was generated through MiniOMS, then this field would be populated.

Conditional yes

items

Objects

The items for the forward/return order. Would be null in case of shiprocket forward order statuses

Conditional yes

items.itemId

String

Item Id

Conditional yes

items.sku

String

SKU of the item

Conditional yes

items.quantity

Integer

Quantity of the item

Conditional yes