> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Returns

> Returns, exchanges, claims, and their line items.

## Queries

* [`return`](/docs/api-reference/v3/reference/returns/queries/return) — Fetch a single return by its id — a branded Redo return id or its legacy Mongo ObjectId.
* [`returnActionRun`](/docs/api-reference/v3/reference/returns/queries/return-action-run) — Fetch a run of a return action by its id, with the outcome for each return so far.
* [`returns`](/docs/api-reference/v3/reference/returns/queries/returns) — List returns, optionally filtered by status, customer email, order name, or update time.

## Mutations

* [`approveReturns`](/docs/api-reference/v3/reference/returns/mutations/approve-returns) — Approve returns that are waiting for review, so each customer can send their items back. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`closeReturns`](/docs/api-reference/v3/reference/returns/mutations/close-returns) — Close returns that were handled outside Redo: every item is marked complete and nothing is refunded. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`flagReturns`](/docs/api-reference/v3/reference/returns/mutations/flag-returns) — Flag returns for attention. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`processReturns`](/docs/api-reference/v3/reference/returns/mutations/process-returns) — Process returns with their default outcome, issuing each refund, store credit or exchange. This moves money and cannot be undone. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`rejectReturns`](/docs/api-reference/v3/reference/returns/mutations/reject-returns) — Reject returns. This cannot be undone. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`resetReturns`](/docs/api-reference/v3/reference/returns/mutations/reset-returns) — Reset returns: each return is deleted so that its customer can start it again. This cannot be undone. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`tagReturn`](/docs/api-reference/v3/reference/returns/mutations/tag-return) — Apply tags to a return by name. `SET` replaces the return's tags; `APPEND` unions them in. Returns null if no return with that id is owned by the caller.
* [`tagReturns`](/docs/api-reference/v3/reference/returns/mutations/tag-returns) — Add a tag to returns by name, keeping the tags each return already has. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.
* [`unflagReturns`](/docs/api-reference/v3/reference/returns/mutations/unflag-returns) — Remove the flag from flagged returns, putting each back in the status its shipments imply. Starts a run and returns it at once; the returns are worked through in the background. Returns null, and starts nothing, if any id is not a return owned by the caller.

## Objects

* [`ExchangeItem`](/docs/api-reference/v3/reference/returns/exchange-item) — An item on the exchange/new order.
* [`ExchangeItemPrice`](/docs/api-reference/v3/reference/returns/exchange-item-price) — The price of an exchange item, with tax.
* [`ExchangeOrder`](/docs/api-reference/v3/reference/returns/exchange-order) — The exchange/new order created for the return.
* [`ExternalRef`](/docs/api-reference/v3/reference/returns/external-ref) — A reference to an external product or variant by id and name.
* [`ExternalReturnId`](/docs/api-reference/v3/reference/returns/external-return-id) — An id for this return in an external system (e.g. Shopify).
* [`ItemRefund`](/docs/api-reference/v3/reference/returns/item-refund) — The refund for a single returned item.
* [`MultipleChoiceQuestion`](/docs/api-reference/v3/reference/returns/multiple-choice-question) — A multiple-choice question and its answer on a return item.
* [`PersonName`](/docs/api-reference/v3/reference/returns/person-name) — A person's given and family name.
* [`ReasonConversation`](/docs/api-reference/v3/reference/returns/reason-conversation) — The conversation Redo had with the shopper to find their return reason.
* [`ReasonConversationMessage`](/docs/api-reference/v3/reference/returns/reason-conversation-message) — A message in a return reason conversation.
* [`Return`](/docs/api-reference/v3/reference/returns/return) — A return, exchange, claim, or warranty a customer opened on an order.
* [`ReturnActionRun`](/docs/api-reference/v3/reference/returns/return-action-run) — One run of a return action over a set of returns. A run works through its returns in the background; poll `returnActionRun` until `status` is no longer `RUNNING`.
* [`ReturnActionRunCounts`](/docs/api-reference/v3/reference/returns/return-action-run-counts) — How many returns of a run ended in each way so far.
* [`ReturnDropoff`](/docs/api-reference/v3/reference/returns/return-dropoff) — A chosen dropoff for returning items without a printed label.
* [`ReturnExchange`](/docs/api-reference/v3/reference/returns/return-exchange) — Exchange details for the return.
* [`ReturnGiftCard`](/docs/api-reference/v3/reference/returns/return-gift-card) — A gift card issued as part of the return.
* [`ReturnIntegration`](/docs/api-reference/v3/reference/returns/return-integration) — A link between this return and an external integration.
* [`ReturnItem`](/docs/api-reference/v3/reference/returns/return-item) — A single item on the return.
* [`ReturnItemExchangeItem`](/docs/api-reference/v3/reference/returns/return-item-exchange-item) — The product exchanged for a returned item.
* [`ReturnNote`](/docs/api-reference/v3/reference/returns/return-note) — A non-system note on the return's timeline.
* [`ReturnProtection`](/docs/api-reference/v3/reference/returns/return-protection) — The Redo coverage behind this return and who it left paying for the label.
* [`ReturnRefund`](/docs/api-reference/v3/reference/returns/return-refund) — A refund transaction issued for the return.
* [`ReturnShipment`](/docs/api-reference/v3/reference/returns/return-shipment) — A return shipment and its tracking details.
* [`ReturnShipmentGroup`](/docs/api-reference/v3/reference/returns/return-shipment-group) — A group of return items shipped together under a single label, with the address they're returned to.
* [`ReturnSource`](/docs/api-reference/v3/reference/returns/return-source) — Who the return is from (the customer).
* [`ReturnTotals`](/docs/api-reference/v3/reference/returns/return-totals) — The monetary totals for the return.

## Enums

* [`ReasonConversationRole`](/docs/api-reference/v3/reference/returns/reason-conversation-role) — Who sent a message in a return reason conversation.
* [`ReturnAction`](/docs/api-reference/v3/reference/returns/return-action) — An action a merchant takes on a return.
* [`ReturnActionResultStatus`](/docs/api-reference/v3/reference/returns/return-action-result-status) — What a run did, or has yet to do, to one return.
* [`ReturnActionRunStatus`](/docs/api-reference/v3/reference/returns/return-action-run-status) — Where a run of a return action stands.
* [`ReturnCompensationMethod`](/docs/api-reference/v3/reference/returns/return-compensation-method) — How a customer is compensated for a return.
* [`ReturnItemStatus`](/docs/api-reference/v3/reference/returns/return-item-status) — The processing status of a single returned item.
* [`ReturnItemStrategy`](/docs/api-reference/v3/reference/returns/return-item-strategy) — The compensation strategy applied to a returned item.
* [`ReturnLabelPayer`](/docs/api-reference/v3/reference/returns/return-label-payer) — Who pays for the return label.
* [`ReturnLabelPayerReason`](/docs/api-reference/v3/reference/returns/return-label-payer-reason) — Why the return label fell to that payer.
* [`ReturnProvisionType`](/docs/api-reference/v3/reference/returns/return-provision-type) — When an exchange or store credit is provisioned.
* [`ReturnSortKey`](/docs/api-reference/v3/reference/returns/return-sort-key) — A field this list can be ordered by; pass to the list's `orderBy` argument and pair with `reverse` to flip direction.
* [`ReturnStatus`](/docs/api-reference/v3/reference/returns/return-status) — The lifecycle status of a return.
* [`ReturnType`](/docs/api-reference/v3/reference/returns/return-type) — What kind of return this is.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.