get https://www.clickpost.in/api/v1/return_order_poll/
The Return Polling Delta API is used to fetch all the return requests raised in the Clickpost system in a 60 minute window. This can be considered as a fallback mechanism to the Return Request Received Webhook mentioned above that is already in place to share this data.
Important Links
Response
meta [meta parameters]
| Field Name | Data Type | Description |
|---|---|---|
success | Boolean | Indicates the success of the API request |
message | String | The message from Clickpost. In case of success it will be "SUCCESS". In that case there are no carrier partners that are servicing the pincodes , it will be ”Pin code not serviceable" |
status | HTTP Code | The HTTP response status code of the API request |
result [result parameters]
| Field Name | Data Type | Description |
|---|---|---|
status | String | Status of the return request |
Return Request Timestamp | String | The date and time of the return request |
cp_id | Num | The carrier partner id |
cp_name | String | The name of the carrier partner |
account_code | String | Name of the account registered by the enterprise on Clickpost dashboard for the carrier partner. Will return a 400 Bad Request response if the given account is inactive or does not exist. |
return_tracking_id | Num | The return tracking ID |
awb | String | The air way bill number of the reverse shipment |
timestamp | String | The timestamp in UTC of the return request |
refund_mode | String | The mode of the refund for the return order |
source | String | The source from where the return request was places |
webhook_payload | JSON Object | The webhook payload |
waybill | String | The Air Way bill number of the reverse shipment |
cp_id | Num | The carrier partner id |
status | String | The status of the return order |
location | String | The location of the return order |
clickpost_status_code | Num | The clickpost tracking status. Reference |
notification_event | Num | The clickpost notification event code https://docs.clickpost.ai/docs/notification-event |
clickpost_status_description | String | The Clickpost tracking status description |
clickpost_status_bucket | Num | In case Enterprise wants to build a custom UI on top of this API, then they can build logic on top of this field https://docs.clickpost.ai/docs/clickpost-status-bucket |
clickpost_status_bucket_description | String | The description of the clubbed Clickpost Status bucket https://docs.clickpost.ai/docs/clickpost-status-bucket |
timestamp | String | The timestamp in UTC of the return request |
remark | String | The remark sent by the carrier partner |
account_code | String | Name of the account registered by the enterprise with the carrier partner defined by carrier_partner_id field. Will return a 400 Bad Request response if the given account is inactive or does not exist. |
additional | JSON Object | The additional details for the particular return order |
latest_status | JSON Object | The latest status of the return order 1. location2. remark3. clickpost_status_code4. clickpost_status_description5. clickpost_status_bucket6. clickpost_status_bucket_description7. timestamp8. status |
is_rvp | Boolean | Whether the order is reverse or not |
forward_awb | String | The original AWB number of the forward shipment |
forward_reference_number | String | The reference number of the forward shipment |
forward_order_id | String | The order ID of the forward shipment |
notification_event_id | Num | The clickpost notification event code https://docs.clickpost.ai/docs/notification-event |
self_shipped | Boolean | Whether the return shipment was self shipped by the customer or not |
item_info | Array | The details of the item being returned to origin |
sku | String | The Stock Keeping Unit of the Item being returned |
quantity | Num | The quantity of the returned item |
return_reason | String | The reason for the return |
refund_mode | String | The mode of the refund for the return order |
return_reference_number | String | The reference number of the return order |