Returns Polling Delta API

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.

Suggest Edits

Overview

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.

Run in Postman API Reference

Usecase

This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders

❗

NOTE

The difference between Start Time and End Time cannot be more that 60 minutes.

Query Parameters

Query Parameters to be passed directly in the URL.

Field NameData TypeFieldDescriptionMax LengthExample
keyStringMandatoryUnique license key provided by Clickpost for the enterprise100"00000000-0000-0000-0000-000000000000"
user_nameStringMandatoryUsername of the enterprise100"Test-username"
start_timeTimestampMandatoryStart time for which the returns needs to be retrieved
YYYY-MM-DDThh:mm:ss		1002022-11-09T11:00:00
end_timeTimestampMandatoryEnd time for which the returns needs to be retrieved
YYYY-MM-DDThh:mm:ss		1002022-11-09T11:10:00

Response

meta [meta parameters]

Field NameData TypeDescriptionExample
successBooleanIndicates the success of the API requesttrue
messageStringThe 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""SUCCESS"
statusHTTP CodeThe HTTP response status code of the API request200

result [result parameters]

Field NameData TypeDescriptionExample
return_reference_numberStringThe unique reference number of the return number"8036651667991648"
statusStringStatus of the return request"SUCCESS"
Return Request TimestampStringThe date and time of the return request"2022-11-09T11:00:48.702402Z"
cp_idNumThe carrier partner id25
cp_nameStringThe name of the carrier partner"Delhivery"
account_codeStringName 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."Delhivery_Reverse"
return_tracking_idNumThe return tracking ID506685194
awbStringThe air way bill number of the reverse shipment "2667237821710"
timestampStringThe timestamp in UTC of the return request"2022-11-09T11:00:50.143090Z"
refund_modeStringThe mode of the refund for the return order"Back to source"
sourceStringThe source from where the return request was places"Returns Page"
webhook_payloadJSON ObjectThe webhook payload
waybillStringThe Air Way bill number of the reverse shipment"2667237821710"
cp_idNumThe carrier partner id25
statusStringThe status of the return order"Return Order Placed"
locationStringThe location of the return order"Stark Tower, Navrangpura, Ahmedabad, 380015"
clickpost_status_codeNumThe clickpost tracking status.
Reference		101
notification_eventNumThe clickpost notification event code https://docs.clickpost.ai/docs/notification-event11
clickpost_status_descriptionStringThe Clickpost tracking status description"Return Order Placed"
clickpost_status_bucketNumIn 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		8
clickpost_status_bucket_descriptionStringThe description of the clubbed Clickpost Status bucket https://docs.clickpost.ai/docs/clickpost-status-bucket"Return Order Placed"
timestampStringThe timestamp in UTC of the return request"2022-11-09T11:00:48.702402Z"
remarkStringThe remark sent by the carrier partner"Return Order Placed"
account_codeStringName 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."Delhivery_Reverse"
additionalJSON ObjectThe additional details for the particular return order
latest_statusJSON ObjectThe latest status of the return order
1. location
2. remark
3. clickpost_status_code
4. clickpost_status_description
5. clickpost_status_bucket
6.clickpost_status_bucket_description
7. timestamp
8. status		{
"location": "",
"remark": "Return Order Placed",
"clickpost_status_code": 101,
"clickpost_status_description": "Return Order Placed",
"clickpost_status_bucket": 8,
"clickpost_status_bucket_description": "Return Order Placed",
"timestamp": "2022-11-09T11:00:48.702402Z",
"status": "Return Order Placed"
}
is_rvpBooleanWhether the order is reverse or nottrue
forward_awbStringThe original AWB number of the forward shipment
forward_reference_numberStringThe reference number of the forward shipment"2290664"
forward_order_idStringThe order ID of the forward shipment"103887038"
notification_event_idNumThe clickpost notification event code https://docs.clickpost.ai/docs/notification-event11
self_shippedBooleanWhether the return shipment was self shipped by the customer or notfalse
item_infoArrayThe details of the item being returned to origin[ {
"sku": "4060981731573",
"quantity": 1,
"return_reason": "Other Reason",
"refund_mode": "Back to source"
}]
skuStringThe Stock Keeping Unit of the Item being returned"4060981731573"
quantityNumThe quantity of the returned item 1
return_reasonStringThe reason for the return"Size Issue"
refund_modeStringThe mode of the refund for the return order"Back to source"
return_reference_numberStringThe reference number of the return order"8036651667991648"

Updated over 1 year ago