Skip to main content

​
Queries

  • return — Fetch a single return by its id — a branded Redo return id or its legacy Mongo ObjectId.
  • returnActionRun — Fetch a run of a return action by its id, with the outcome for each return so far.
  • returns — List returns, optionally filtered by status, customer email, order name, or update time.

​
Mutations

  • approveReturns — 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 — 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 — 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 — 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 — 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 — 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 — 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 — 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 — 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 — 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.
  • ReasonConversation — The conversation Redo had with the shopper to find their return reason.
  • ReasonConversationMessage — A message in a return reason conversation.
  • Return — A return, exchange, claim, or warranty a customer opened on an order.
  • ReturnActionRun — 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 — How many returns of a run ended in each way so far.
  • 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.
  • ReturnProtection — The Redo coverage behind this return and who it left paying for the label.
  • ReturnRefund — A refund transaction issued for the return.
  • ReturnShipment — A return shipment and its tracking details.
  • ReturnShipmentGroup — A group of return items shipped together under a single label, with the address they’re returned to.
  • ReturnSource — Who the return is from (the customer).
  • ReturnTotals — The monetary totals for the return.

​
Enums