The following shipment events help to cover the return process and inform a consumer about changes on her shipment.
Methods
Parameters
| Parameter | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| id | yes | string | "123000001" | The reference shipment ID |
| datetime | yes | datetime | "2021-05-10T17:38:23.279Z" | The timestamp on event creation |
| event | yes | string | choice | "refunded" | The event name |
Supported events
Name | Description |
|---|---|
| Refunded | The event when the shipment got refunded |
| Returned to warehouse | The event when shipment has been returned to the warehouse |
Do you want to know more about shipment events and statuses? Please find the page under the link: Explaining Statuses and Events