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

ToolWhat it returns
get_return_requestOne return request by Carriyo return_request_id.
list_return_requestsReturn requests with paging, search, aggregation, and merchant filters.

Writes — create / edit

ToolWhat it does
create_return_requestCreate a new return request.
edit_return_requestPatch an existing return request.

State transitions

ToolWhat it does
approve_return_requestApprove a pending return request.
reject_return_requestReject with a reason.
receive_return_request_itemsMark received items, with received quantities.
ship_return_requestCreate reverse shipment(s) for approved return items.
cancel_return_requestCancel a return request.
complete_return_requestMark a return request as completed.