Returns

​

Queries

• return — Fetch a single return by its id — a branded Redo return id or its legacy Mongo ObjectId.
• returns — List returns, optionally filtered by status, customer email, order name, or update time.

​

Mutations

• tagReturn — 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.

​

Objects

• Assessment — A merchant assessment recorded while processing an item.
• AssessmentResponse — One response within an assessment.
• AssessmentUser — The user assigned to an assessment. Only the id is stored on the returns mirror; name/email require the user directory and are empty here.
• ExchangeItem — An item on the exchange/new order.
• ExchangeItemPrice — The price of an exchange item, with tax.
• ExchangeOrder — The exchange/new order created for the return.
• ExternalRef — A reference to an external product or variant by id and name.
• ExternalReturnId — An id for this return in an external system (e.g. Shopify).
• ItemRefund — The refund for a single returned item.
• MultipleChoiceQuestion — A multiple-choice question and its answer on a return item.
• PersonName — A person’s given and family name.
• Return — A return, exchange, claim, or warranty a customer opened on an order.
• ReturnAmount — A single monetary amount.
• ReturnDestination — Where the returned items are shipped to (the merchant).
• ReturnDropoff — A chosen dropoff for returning items without a printed label.
• ReturnExchange — Exchange details for the return.
• ReturnGiftCard — A gift card issued as part of the return.
• ReturnIntegration — A link between this return and an external integration.
• ReturnItem — A single item on the return.
• ReturnItemExchangeItem — The product exchanged for a returned item.
• ReturnNote — A non-system note on the return’s timeline.
• ReturnOrder — The order this return was created against.
• ReturnRefund — A refund transaction issued for the return.
• ReturnShipment — A return shipment and its tracking details.
• ReturnSource — Who the return is from (the customer).
• ReturnTag — A tag applied to the return.
• ReturnTotals — The monetary totals for the return.

​

Enums

• ReturnCompensationMethod — How a customer is compensated for a return.
• ReturnItemStatus — The processing status of a single returned item.
• ReturnItemStrategy — The compensation strategy applied to a returned item.
• ReturnProvisionType — When an exchange or store credit is provisioned.
• ReturnSortKey — A field this list can be ordered by; pass to the list’s orderBy argument and pair with reverse to flip direction.
• ReturnStatus — The lifecycle status of a return.
• ReturnType — What kind of return this is.