The Return Request Object
A Carriyo Return object represents a customer return request. A Carriyo return is created when a customer requests to return an item for some reason. For example, the item was damaged on delivery or the product is not as advertised or simply the customer has changed their mind.
When a return is initiated, a business user can approve the request, which may result in the creation of a reverse shipment.
The Carriyo Returns API allows the merchant to create, approve reject and manage return requests. It also allows the merchant to define allowed return reasons, resolutions and other return settings.
return_request_id | string |
shipments | Array of strings List of shipment ids associated with this return request. |
partner_order_reference | string |
Array of objects (Return Request Additional Reference) List of additional references associated with this return request. | |
merchant | string |
status | |
object (Pickup Object) | |
customer_comment | string |
channel | string |
Array of objects | |
Array of objects (Return Request Item) | |
refund_method | string |
object (Return Refund Information) | |
creation_date | string |
update_date | string |
approval_date | string |
cancellation_date | string |
rejection_date | string |
completion_date | string |
Array of objects (Return Request Items Update) |