Non-Delivery Report related info, for example the payload shown when a delivery attempt fails.
Fields
show_ndr_form
BooleanIndicates whether to show NDR form or not. For example, true when customer needs to update address.
non_editable_address_fields
[String]A list of fields that are not allowed to be updated while filling a new address in the NDR form. For example, ['pincode', 'city'].
allowed_delivery_window
NdrDeliveryWindowA range of dates in between which delivery can be reattempted. For example, { start_date: '2024-11-06', end_date: '2024-11-10' }.
delivery_scheduled_date
StringThe specific date on which the courier partner is expected to reattempt delivery of the shipment. For example, '2024-11-08'.
failure_reason
StringThe reason recorded by the courier or delivery partner for the failed delivery attempt. For example, 'Customer unavailable'.
delivery_partner_remarks
StringAny extra notes or observations added by the delivery partner at the time of a failed delivery attempt. For example, 'Gate locked'.
customer_remarks
StringAdditional comments provided by the customer while rescheduling the delivery. For example, 'Please attempt after 7 PM'.
Was this section helpful?