list_return_requests
Updated May 21, 20261 min read
List return requests with paging, search, aggregation, merchant filters, date filters, and item-aware filters. Use select with json-mask syntax to trim the returned payload.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
agg_by | string | No | Aggregate by status, merchant, resolution, return_reason, return_item_condition, assigned_to_user, or other supported return-request fields. |
assigned_to_user | oneOf | No | — |
collection_after_date_from | string | No | — |
collection_after_date_to | string | No | — |
collection_before_date_from | string | No | — |
collection_before_date_to | string | No | — |
country_access | oneOf | No | — |
creation_date_from | string | No | — |
creation_date_to | string | No | — |
dropoff_location | oneOf | No | — |
fields | oneOf | No | — |
item_status | oneOf | No | — |
location_access | oneOf | No | — |
merchant | oneOf | No | — |
page | oneOf | No | — |
page_size | oneOf | No | — |
pickup_city | oneOf | No | — |
pickup_country | oneOf | No | — |
pickup_state | oneOf | No | — |
resolution | oneOf | No | — |
return_item_condition | oneOf | No | — |
return_reason | oneOf | No | — |
return_request_ids | oneOf | No | — |
search_string | string | No | — |
select | string | No | json-mask expression to filter response fields. |
sort_by | string | No | — |
sort_direction | string | No | Values: asc, desc, ASC, DESC. |
status | oneOf | No | — |
statuses | oneOf | No | — |
tzoffset | oneOf | No | — |
Example agent prompt
"Show me the recent return requests."
list_return_requests(
tenantId="…"
)