get_return_request

Updated May 21, 20261 min read

Get a single return request by Carriyo return_request_id via GET /returns/requests/{returnId}. Use select with json-mask syntax to return only required fields.

Parameters

NameTypeRequiredDescription
return_request_idstringYesCarriyo return_request_id.
tenantIdstringYes
selectstringNojson-mask expression to filter response fields.

Example agent prompt

"Look up the return request for me."

get_return_request(
  tenantId="…",
  return_request_id="RR-9876"
)