Outbound | POST | {Client’s URL}
Summary
This API will push notifications to the client’s system.
Description
This API will push notifications to the client’s systems. Notifications can be of the forward order statuses or it can be of return orders. These notifications pushed can be from both Clickpost and/or Shiprocket (based on the configuration).
Request (Forward Order Payload)
{
"forwardOrderCode":"order-1",
"forwardAwb":"awb-1",
“courierName”:”SELF”,
"notificationType":"PICKED_UP",
"logisticAggregatorInfo":{
"logisticAggregatorName":"CLICKPOST",
"logisticAggregatorMetaData":{
"Account Code":"ABCD",
"Security Key":"12abcd12",
}
}
"returnOrderInfo":null,
"warehouseCode":"wh-1",
"items":[
{
"itemId":"2",
"sku":"puma-sku-1",
"quantity":1
}
]
}
The above request is a sample notification for a forward order notification.
Request (Return Order Payload)
{
"forwardOrderCode":"order-1",
"forwardAwb":null,
“courierName”:”SELF”,
"notificationType":"PICKED_UP",
"logisticAggregatorInfo":{
"logisticAggregatorName":"CLICKPOST",
"logisticAggregatorMetaData":{
"Account Code":"ABCD",
"Security Key":"12abcd12",
}
}
"returnOrderInfo":{
"returnOrderId":"2",
"returnAwb":"awb-1_rev",
"transporter":"Self Reverse",
"returnOrderTime":"2021-07-14T13:23:02Z"
},
"warehouseCode":"wh-1",
"items":[
{
"itemId":"2",
"sku":"puma-sku-1",
"quantity":1
}
]
}
The above request is a sample notification payload for a return order notification. The return order details will be found in the returnOrderInfo object.
Parameter Name | Data Type | Description | Mandatory |
| String | Forward Order Code | yes |
| String | Forward AWB for the order. If the notification is of forward order, this field would be present. | Conditional yes |
| String | The type of notification that is being sent. The possible values are listed in the Notification Type section | yes |
| Object | Return Order Information. Will be present if the notification type is a return type(AWB_GENERATED, RETURN_PICKUP, RTO etc.) | Conditional yes |
| String | Return Order Id | Conditional yes |
| String | Return Awb | Conditional yes |
| String | Courier for the return order | Conditional yes |
| Date | Return Order Time | Conditional yes |
| Object | This contains the custom fields sent by Clickpost/Shiprocket | yes |
| String | Logistic Aggregator type. Can be CLICKPOST or SHIPROCKET | yes |
| Object | Map of extra information that are passed to us by logistic aggregators. Example - Account Code, Security Key etc. in Clickpost’s case | yes |
| String | Warehouse Code for the forward/return order. If the shipping label was generated through MiniOMS, then this field would be populated. | Conditional yes |
| Objects | The items for the forward/return order. Would be null in case of shiprocket forward order statuses | Conditional yes |
| String | Item Id | Conditional yes |
| String | SKU of the item | Conditional yes |
| Integer | Quantity of the item | Conditional yes |
Notification Type
The following are the types of notifications that can be sent to the client’s system
Notification Type | Applicable for | Description |
| Clickpost | Shipping Label has been generated |
| Clickpost,Shiprocket | Courier is out to pick up the shipment |
| Clickpost | Courier has picked up the return order |
| Clickpost,Shiprocket | Courier is out to deliver the shipment |
| Clickpost | shipment could not be delivered ( e.g. address not found, person not available) |
| Clickpost,Shiprocket | Shipment delivered successfully |
| Clickpost,Shiprocket | Shipment could not be delivered and the shipment is now being sent back to its origin/Warehouse |
| Clickpost | Customer has placed the return order |
| Clickpost | AWB is generated for the shipment |
| Clickpost,Shiprocket | Shipment has been canceled (e.g customer cancellation) |
| Clickpost,Shiprocket | Shipment delivered to origin |
| Clickpost | fwd order picked up from warehouse to exchange against the return order |
| Clickpost | Return order picked up, fwd order delivered |
| Clickpost | shipment from warehouse canceled |
| Clickpost | Shipment is stuck in transit |
| Clickpost | Shipment not delivered on time |
| Clickpost,Shiprocket | Shipment lost in transit |
| Clickpost,Shiprocket | Shipment damaged in transit |
| Shiprocket | Invoice for shipment has been generated |
| Shiprocket | Shipment Label has been generated |
| Shiprocket | Shipment pick up has been scheduled and pick request is sent to courier partner |
| Shiprocket | Shipment dispatched from the Warehouse |
| Shiprocket | |
| Shiprocket | |
| Shiprocket | Shipment is in queue for pickup post shipment pickup was scheduled |
| Shiprocket | Pick up is rescheduled |
| Shiprocket | An order for which there is some error in pick up generation |
| Shiprocket | Cancellation has been requested for the order |
| Shiprocket | Shipment is in transit |
| Shiprocket | Shipment could not be delivered in first attempt. |
| Shiprocket | Shipment is delayed but within SLA |
| Shiprocket | |
| Shiprocket | |
| Shiprocket | |
| Shiprocket | During transit shipment reached from one HUB to final HUB before delivering to customer |
| Shiprocket | Shipment sent to wrong route |
| Clickpost,Shiprocket | Shipment picked up from the warehouse |
| Shiprocket | An order for which RTO is acknowledged by seller |
FAQs
How can I identify if the notification is for a forward order or a return order?
If the “returnOrderInfo“ field is null, then it is a forward order notification. If it is not null, it is a return order notification.