Push Notification API

Inbound | POST | /rms-magic/notification/push

Forward Order Request

{
  "forwardOrderCode": "asdf1234",
  "forwardShipmentCode": "101",
  "forwardAwb": "12541231",
  "notificationType": "IN_TRANSIT",
  "shipmentType": "FORWARD",
  "logisticAggregatorName": "NARVAR",
  "warehouseCode": "wh-1",
  "returnOrderInfo": null,
  "items": [
    {
      "sku": "sku-1",
      "quantity": 1
    }
  ]
}

Return Order Request

{
  "forwardOrderCode": "asdf1234",
  "forwardShipmentCode": "101",
  "forwardAwb": "12541231",
  "notificationType": "RETURN_PICKUP",
  "shipmentType": "RETURN",
  "logisticAggregatorName": "NARVAR",
  "warehouseCode": "wh-1",
  "returnOrderInfo": {
    "returnOrderId": "return-asdf1234",
    "returnAwb": "return1235123",
    "carrierName": "Delhivery Reverse"
  },
  "lineItems": [
    {
      "sku": "sku-1",
      "quantity": 1
    }
  ]
}

Parameter Name	Data Type	Description	Mandatory
`forwardOrderCode`	String	This is the forward order id with which the rms identifies each order. This forwardOrderCode is same as orderNumber which would have been passed in the request payload of the generate shipping label API call.	yes
`forwardShipmentCode`	String	This is the unique forward shipment code with which rms identifies each shipment in an order. This forwardShipmentCode is the same as shipmentCode which was passed in generate shipping label API call.
`forwardAwb`	String	This is the tracking number of the forward order	no
`carrierName`	String	This is the carrier who is handling the forward order shipment. This is required when the notification type is of a forward order (IN_TRANSIT,DELIVERED etc.)	no
`notificationType`	String	The notification type for this order that is being pushed	yes
`shipmentType`	String	If the notification being pushed is for the forward order or a return order	yes
`logisticAggregatorName`	String	The logistic aggregator name	yes
`warehouseCode`	String	The warehouse code for this order	no
`returnOrderInfo`	Object	The return order details if the notification is for a return order	no
`returnOrderInfo.returnOrderId`	String	The return order id with which the return order was created.	yes
`returnOrderInfo.returnAwb`	String	The return awb of the return order	yes
`returnOrderInfo.carrierName`	String	The carrier of the return order	yes
`lineItems`	List	The list of items for the order whose notification is being sent	yes
`lineItems.sku`	String	The SKU of the item	yes
`lineItems.quantity`	Integer	The quantity of the item	yes