Skip to main content
Emits: RETURN_CREATED, RETURN_UPDATED Required scopes: returns_read, returns_write
How the customer is compensated (e.g. refund, store credit, exchange).
Boolean!
required
Whether the return was closed without any action taken.
required
When the return was created.
Chosen label-free dropoffs for returning items.
Exchange details for the return.
This return’s ids in external systems (e.g. Shopify).
Gift cards issued as part of the return.
ID!
required
The id of this return.
Links to this return in external integrations.
String
The name of the merchant user who created the return, if merchant-created.
The items being returned.
String!
required
The return’s legacy Mongo ObjectId (24-char hex), for cross-referencing v2 data.
Non-system notes on the return’s timeline.
The orders the returned items came from.Requires: orders_read
The Redo coverage behind this return and who it left paying for the label.
Refund transactions issued for the return.
The shipment groups for the return; each carries its destination and shipments.
Who the return is from (the customer).
The return’s current lifecycle status.
[String!]!
required
Tags applied to the return.
The monetary totals for the return.
required
What kind of return this is.
required
When the return was last updated.