create_return_request
Updated May 21, 20261 min read
Create a return request via POST /returns/requests. This tool does not support image upload; items whose return reason requires images will fail downstream.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
items | array | Yes | — |
merchant | string | Yes | — |
partner_order_reference | string | Yes | — |
tenantId | string | Yes | — |
carriyo_metadata | array | No | — |
channel | string | No | — |
collection | object | No | — |
customer_comment | string | No | — |
email_or_phone | string | No | — |
pickup | object | No | — |
refund_method | string | No | — |
Example agent prompt
"Create a new return request."
create_return_request(
tenantId="…",
merchant="acme",
partner_order_reference=…,
items=…
)