Outbound | POST | {Client’s URL}

Summary

This API pushes shipment and return notifications to the client’s system.

This is applicable for marketplaces/webshops where RMS receives shipment/return status updates via integrated logistics aggregators and then pushes those updates to the client.

Description

This outbound API is used to notify external systems about forward shipment and return order status updates.

Typical use‑cases include:

Request Body

{
  "forwardOrderCode": "ORD-12345",
  "forwardShipmentCode": "SHIP-98765",
  "forwardAwb": "AWB123456789",
  "notificationType": "DELIVERED",
  "notificationUpdateTime": 1708425600,
  "returnOrderInfo": {
    "returnOrderId": "RET-112233",
    "returnOrderTime": 1708429200,
    "returnAwb": "R-AWB-998877",
    "transporter": "DHL",
    "returnOrderStatus": "RTO",
    "expectedDate": 1708512000
  },
  "logisticAggregatorInfo": {
    "logisticAggregatorName": "SHIPWAY",
    "logisticAggregatorMetaData": {
      "key1": "value1",
      "key2": "value2"
    }
  },
  "warehouseCode": "WH-001",
  "courierName": "DHL",
  "items": [
    {
      "itemId": "ITEM-001",
      "sku": "SKU-123",
      "quantity": 2,
      "returnReason": "Damaged item",
      "refundMode": "REFUND_TO_SOURCE",
      "exchangeSku": "SKU-EX-999",
      "exchangeReason": "Size mismatch"
    }
  ]
}

Field Reference

Parameter Name Data Type Description Mandatory
forwardOrderCode String Forward (original) order code for which the notification is being sent. No
forwardShipmentCode String Shipment identifier associated with the forward order. No
forwardAwb String Tracking number for the forward shipment. No
notificationType String Type of notification, e.g. DELIVERED, RETURN_ORDER_PLACED, RTO, RTO_DELIVERED, AWB_GENERATED, PICKUP_FAILED, etc. This is an ENUM. No
notificationUpdateTime Long Time of the event/notification in epoch seconds. No
warehouseCode String Code of the warehouse/location from where the shipment/return is processed. No
courierName String Name of the courier/transport partner. No
returnOrderInfo Object Container for return order–specific information. No
returnOrderInfo.returnOrderId String Identifier of the return order in the channel/RMS. No
returnOrderInfo.returnOrderTime Long Time at which the return order was placed, in epoch seconds. No
returnOrderInfo.returnAwb String AWB / tracking number associated with the return shipment. No
returnOrderInfo.transporter String Transporter / logistics partner handling the return. No
returnOrderInfo.returnOrderStatus String Return order status (status semantics depend on integration; often aligns with return lifecycle such as RTO). No
returnOrderInfo.expectedDate String Expected date/time for the return event. No
logisticAggregatorInfo Object Information about the logistics aggregator used (if any). No
logisticAggregatorInfo.logisticAggregatorName String Name of the logistics aggregator. No
logisticAggregatorInfo.logisticAggregatorMetaData Object Additional metadata related to the logistics aggregator in the form of key-value pairs. No
items List
List of items associated with the notification (shipment items or return items). No
items[].itemId String Internal RMS/return item identifier. No
items[].sku String SKU identifier for the item. No
items[].quantity Integer Quantity relevant to this notification (e.g., delivered/returned quantity). No
items[].returnReason String Reason provided for return of the item. No
items[].refundMode String Mode in which the refund is to be processed. No
items[].exchangeSku String SKU to be exchanged/replaced against the original item (if applicable). No

Response Body

HttpStatus : 200