Skip to main content
These read-only tools let an assistant search for returns, inspect a single return in detail, and review a return’s event timeline. Each tool renders a Generative UI card so the merchant can drill in without leaving the chat.

List Returns

Tool name: list-returns-tool  ·  Read-only  ·  Permissions: list-returns or manage-returns Search and paginate the authenticated shop’s returns with rich filtering. Filters compose with AND semantics across distinct fields and OR semantics within multi-value fields (status, label_status, return_method_state).

Parameters

Example prompts

“Show me the most recent 10 returns flagged for review.”
“List returns delivered in the last 7 days that haven’t been processed yet.”

Get Return Details

Tool name: get-return-tool  ·  Read-only  ·  Permissions: list-returns or manage-returns Fetch full detail for a single return, including order info, state, customer, line items, refund/exchange resolution, and notes. Renders an interactive card with action buttons for Process, Cancel, Close, Reject, and Timeline.

Parameters

Example prompts

“Get return #1234 and summarize what’s happening.”
“Pull up the details for the return I just flagged.”

Get Return Timeline

Tool name: get-return-timeline-tool  ·  Read-only  ·  Permissions: list-returns or manage-returns Retrieve the chronological event timeline for a return — creations, state changes, label generation, shipping events, processing actions, customer notifications, and manual merchant actions. Large event payloads are truncated automatically.

Parameters

Example prompts

“What happened with return #1234? Walk me through the timeline.”
“When was the label for this return generated?”