Return Order Placed Webhook
This Webhook is only useful for customers using Clickpost’s managed returns platform to accept customer returns on their website
Payload Explanation:
| Field Name | Data Type | Description | Example |
|---|---|---|---|
| `location` | `String` | The location of the return order | "Stark Tower, Navrangpura, Ahmedabad, 380015" |
| `remark` | `String` | The remark sent by the | "Return Order Placed" |
| `notification_event_id` | `Num` | The clickpost notification event code [https://docs.clickpost.ai/docs/notification-event](https://docs.clickpost.ai/docs/notification-event) | 11 |
| `timestamp` | `String` | The timestamp in UTC of the return request | "2022-11-09T11:00:48.702402Z" |
| `clickpost_status_code` | `Num` | The clickpost tracking status.\ [Reference](https://docs.clickpost.ai/docs/tracking-status-codes) | 101 |
| `cp_id` | `Num` | The [carrier partner id](https://carriers.clickpost.ai/) | 25 |
| `clickpost_status_bucket_description` | `String` | The description of the clubbed Clickpost Status bucket [https://docs.clickpost.ai/docs/clickpost-status-bucket](https://docs.clickpost.ai/docs/clickpost-status-bucket) | "Return Order Placed" |
| `waybill` | `String` | The Air Way bill number of the reverse shipment | "2667237821710" |
| `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](https://docs.clickpost.ai/docs/clickpost-status-bucket) | 8 |
| `status` | `String` | Status of the return request | "SUCCESS" |
| `clickpost_status_description` | `String` | The Clickpost tracking status description | "Return Order Placed" |
| `additional` | `JSON Object` | The additional details for the particular | |
| `clickpost_status_bucket_description` | `String` | The description of the clubbed Clickpost Status bucket [https://docs.clickpost.ai/docs/clickpost-status-bucket](https://docs.clickpost.ai/docs/clickpost-status-bucket) | "Return Order Placed" |
| `clickpost_status_description` | `String` | The Clickpost tracking status description | "Return Order Placed" |
| `clickpost_status_bucket` | `Num` | In case Enterprise wants to build a custom UI on | |
| `remark` | `String` | The remark sent by the | "Return Order Placed" |
| `status` | `String` | Status of the return request | "SUCCESS" |
| `location` | `String` | The location of the return order | "Stark Tower, Navrangpura, Ahmedabad, 380015" |
| `timestamp` | `String` | The timestamp in UTC of the return request | "2022-11-09T11:00:48.702402Z" |
| `clickpost_status_code` | `Num` | The clickpost tracking status.\ [Reference](https://docs.clickpost.ai/docs/tracking-status-codes) | 101 |
| `is_rvp` | `Boolean` | Whether the order is reverse or not | true |
| `notification_event_id` | `Num` | The clickpost notification event code [https://docs.clickpost.ai/docs/notification-event](https://docs.clickpost.ai/docs/notification-event) | 11 |
| `forward_order_id` | `String` | The order ID of the forward shipment | "103887038" |
| `self_shipped` | `Boolean` | Whether the return shipment was self shipped by the customer or not | false |
| `forward_reference_number` | `String` | The reference number of the forward shipment | "2290664" |
| `item_info` | `Array` | The details of the item being returned to origin | [ { "sku": "4060981731573", "quantity": 1, "return_reason": "Other Reason", "refund_mode": "Back to source" }] |
| `sku` | `String` | The Stock Keeping Unit of the Item being returned | "4060981731573" |
| `quantity` | `Num` | The quantity of the returned item | 1 |
Important Links
Usecase
This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders
Geography
This is a standard API which supports all shipments created and transported within
- India
- North America
- Europe
- Middle East
- South East Asia
Updated 7 months ago
Did this page help you?
