Create return
create_returnOpen an approved return on an order for items a customer is sending back without moving money or stock; restocking and refunds are handled separately.
Instructions
Open a return on an order for items the customer is sending back. A return opened by the merchant starts approved. It does not move money or stock: receive_return restocks, refund_return records the refund. Pass an idempotencyKey and, if the call times out or fails unclearly, retry with the same idempotencyKey so the retry cannot open a second return on the order.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"orderId": "<orderId>",
"lines": "<lines>"
},
"name": "create_return"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| lines | Yes | Lines and quantities coming back; only units already handed to the carrier or the customer | |
| carrier | No | Carrier of the return parcel | |
| orderId | Yes | ||
| idempotencyKey | No | Your own unique value for this return (e.g. a UUID you generate), up to 128 characters. If the call times out or its result is unclear, retry with the same idempotencyKey: the repeat returns the return the first call created instead of creating a second one, and ignores the repeat's other input. Use a new value for a different return. Omit it and every call creates. | |
| trackingNumber | No | Tracking number of the return parcel |