Returns tools
Updated May 21, 20261 min read
10 tools for the return-request lifecycle. Reference data (return reasons, resolutions, rejection reasons, item conditions, refund types) lives under Lookups.
Reads
| Tool | What it returns |
|---|---|
get_return_request | One return request by Carriyo return_request_id. |
list_return_requests | Return requests with paging, search, aggregation, and merchant filters. |
Writes — create / edit
| Tool | What it does |
|---|---|
create_return_request | Create a new return request. |
edit_return_request | Patch an existing return request. |
State transitions
| Tool | What it does |
|---|---|
approve_return_request | Approve a pending return request. |
reject_return_request | Reject with a reason. |
receive_return_request_items | Mark received items, with received quantities. |
ship_return_request | Create reverse shipment(s) for approved return items. |
cancel_return_request | Cancel a return request. |
complete_return_request | Mark a return request as completed. |