Customer Feedback API
This API enables customers to retrieve feedback from end-users in case of failure of delivery of any shipment. Users can update their preferred location of delivery at Clickpost Tracking Page, and those changes are retrieved by this API.
Overview
Using this API, customers will be able to retrieve feedback from end-users when their shipment is in the failed delivery stage. Users can update their preferred location of delivery, preferred date for reattempt and can provide their mobile number at Clickpost Tracking Page, and those changes are retrieved by this API. With help of this API customers can collate and analyze data that is received from their end-customer.
Usecase
This is a standard API which applies to all orders.
URL
GET <https://www.clickpost.in/api/v1/ndr_user_feedback/>
Query Parameters
| Field Name | Data Type | Field | Description | Max Length | Example |
|---|---|---|---|---|---|
username | String | Mandatory | Username of the registered enterprise | 100 | "test-enterprise" |
key | String | Mandatory | Unique license key for the enterprise user | 100 | "00000000-0000-0000-0000-000000000000" |
start_time | Integer | Mandatory | Epoch time (in seconds) denoting the start of the time period within which the feedback is required | 1666768415 | |
end_time | Integer | Mandatory | Epoch time (in seconds) denoting the end of the time period within which the feedback is required. | 1666772015 |
NOTE
The time difference between
start_timeandend_timecan be at most 3600 seconds (60 mins).
Response
The sample response can have the following fields
| Field Name | Data Type | Description |
|---|---|---|
meta | Object | Metadata for the result, e.g. status code, error messages. |
result | List of Objects | A list of objects, each denoting a feedback provided by the user. |
Response Meta
| Field Name | Data Type | Description |
|---|---|---|
status | Integer | Status code of the response (including, but not limited to HTTP Status codes) |
message | String | Error message (if any errors) for the request. |
success | Boolean | Whether the request is successful or not. |
Response Result Object
Each object in the result list may consist of the following fields.
| Field Name | Data Type | Description |
|---|---|---|
type | String | Type of NDR feedback received. Can be either CLIENT_OPS_FEED or CUSTOMER_FEED |
awb | String | AWB of the order for which NDR feedback is provided |
address | String/Null | Address of delivery, updated by the user at the tracking page |
landmark | String/Null | Landmark of the address of delivery, updated by the user at the tracking page |
drop_pincode | String/Null | Pincode of delivery address, updated by the user at the tracking page |
preferred_date | String/Null | Preferred date of delivery of the order (in YYYY-MM-DD format if not null) |
preferred_time | String/Null | Preferred time of delivery of the order (in HH:MM:SS format if not null) |
phone | String/Null | Phone number for delivery, updated at the tracking page |
comment | String/Null | Comment about the change of order by the user, updated at the tracking page |
created_at | String | Timestamp when the user requested the change of the above details (in YYYY-MM-DDTHH:MM:SS format) |
clickpost_status_code | Integer | Status code of the shipment when the end-user entered the feedback |
api_data_push | Boolean/Null | Whether the updated data has been pushed to the carrier partner APIs via Clickpost's API or not. Can take 3 values based on the course of action: - null: There was no attempt to push data from Clickpost's end,- true: The updated data was successfully pushed to the carrier partner APIs- false: There was an attempt to push data, but it failed. |
clickpost_status_description | String | Brief description of the status of the shipment when the end-user entered the feedback. |
is_rejected | Boolean/Null | Whether customer has rejected the shipment |
reference_number | String | Reference number of the shipment |
additional | Object | Additional feedback related to steps taken internally by CST |
Response Result - 'additional' Field
| Field Name | Data Type | Description |
|---|---|---|
internal_username | String | The login username agent has used to retrieve feedback |
internal_cst_responded | Boolean | Whether customer support team of the enterprise has taken any action regarding the shipment |
internal_comment | String | Comments added by CST regarding the shipment |
Sample Response
{
"result": [
{
"type": "CLIENT_OPS_FEED",
"awb": "14406222193559",
"address": null,
"landmark": null,
"drop_pincode": null,
"preferred_date": null,
"preferred_time": null,
"phone": null,
"comment": null,
"created_at": "2022-10-26T07:14:26.990196Z",
"clickpost_status_code": 9,
"api_data_push": true,
"clickpost_status_description": "Delivery Failed",
"is_rejected": null,
"reference_number": "2258032",
"additional": {
"internal_username": "puma",
"internal_cst_responded": true,
"internal_comment": "Mark as RTO"
}
},
{
"type": "CLIENT_OPS_FEED",
"awb": "14406222146670",
"address": null,
"landmark": null,
"drop_pincode": null,
"preferred_date": "2022-10-27",
"preferred_time": null,
"phone": null,
"comment": null,
"created_at": "2022-10-26T07:15:29.342983Z",
"clickpost_status_code": 9,
"api_data_push": true,
"clickpost_status_description": "Delivery Failed",
"is_rejected": null,
"reference_number": "2264139",
"additional": {
"internal_username": "puma",
"internal_cst_responded": false,
"internal_comment": "re-attempt\n"
}
},
{
"type": "CLIENT_OPS_FEED",
"awb": "14406222104411",
"address": null,
"landmark": null,
"drop_pincode": null,
"preferred_date": "2022-10-27",
"preferred_time": null,
"phone": null,
"comment": null,
"created_at": "2022-10-26T07:16:10.938830Z",
"clickpost_status_code": 9,
"api_data_push": true,
"clickpost_status_description": "Delivery Failed",
"is_rejected": null,
"reference_number": "2171425",
"additional": {
"internal_username": "puma",
"internal_cst_responded": false,
"internal_comment": "re-attempt\n"
}
},
{
"type": "CLIENT_OPS_FEED",
"awb": "SF170682117PUM",
"address": null,
"landmark": null,
"drop_pincode": null,
"preferred_date": "2022-10-27",
"preferred_time": null,
"phone": null,
"comment": null,
"created_at": "2022-10-26T07:16:18.491641Z",
"clickpost_status_code": 9,
"api_data_push": true,
"clickpost_status_description": "Delivery Failed",
"is_rejected": null,
"reference_number": "2265894",
"additional": {
"internal_username": "puma",
"internal_cst_responded": false,
"internal_comment": "Re scheduled for delivery"
}
}
],
"meta": {
"meta": {
"status": 200,
"message": "Success",
"success": true
}
}
}
{
"meta": {
"status": 500,
"message": "(end_date-start_date) diff can not be more than 3600 seconds",
"success": false
}
}
Updated over 1 year ago