Push Proof Of Delivery Notification

Inbound | PUT | /orders/{orderCode}/delivered

Summary

This API is used to send Proof of delivery notification when they are delivered to end customer

Description

This API is used to push the Proof Of Delivery Notification for the shipments delivered to the end customer to shopfront system so that it can be shown on the Order delivery page of Shopfronts.

Request

{
    "channelOrderStatus": "Delivered",
    "locationCode": "l123",
    "channelShipmentDeliveredData": [
        {
            "shipmentCode": "UIfd897",
            "deliveredAt": "2020-10-16T20:22:28.000+00:00"
        },
        {
            "shipmentCode": "UIfd898",
            "deliveredAt": "2020-10-12T20:22:28.000+00:00"
        }
    ]
}

Parameter Name	Data Type	Description	Mandatory
`locationCode`	String	Code used by channels to identify a warehouse	no
`channelOrderStatus`	String	Status of order at channel	no
`channelShipmentDeliveredData`	Object[]	List of shipments delivered	yes
`channelShipmentDeliveredData.shipmentCode`	String	Shipment code of the shipment delivered	yes
`channelShipmentDeliveredData.deliveredAt`	String	Delivered time of the shipment	no

Response

EmptyBody

HttpStatus : 200