returns_read
Arguments
ID!
required
The id of the return: a branded Redo id or a 24-char Mongo ObjectId hex.
Returns
A return, exchange, claim, or warranty a customer opened on an order.
Show fields
Show fields
required
How the customer is compensated (e.g. refund, store credit, exchange).
Boolean!
required
Whether the return was closed without any action taken.
required
required
Exchange details for the return.
Show fields
Show fields
Int!
required
Total quantity of exchange items.
required
The items on the exchange order.
Show fields
Show fields
String!
required
The exchange item id.
String
The exchange order’s line item id, if known.
required
The item’s price.
Float!
required
The exchanged quantity.
String
The item’s SKU.
required
The exchanged-for variant.
required
The exchange/new order.
Show fields
Show fields
String
The exchange order’s external id.
How the exchange is provisioned.
required
required
ID!
required
The id of this return.
required
String
The name of the merchant user who created the return, if merchant-created.
required
The items being returned.
Show fields
Show fields
String!
required
Free-text comments the customer left for this item.
The item exchanged for this one, if an exchange.
Show fields
Show fields
required
The exchanged-for product.
Int!
required
The exchanged quantity.
required
The exchanged-for variant.
String
A merchant-set external identifier for the item.
String
The external return line item id, if any.
String
The merchant-assigned grade.
Boolean
Whether the item is a green (keep-it) return.
ID!
required
The return item id.
required
String
The id of the order line item this return item came from.
String
The merchant-assigned processing outcome.
[String!]!
required
Merchant-uploaded processing images.
String
Merchant processing notes.
String
The merchant price adjustment for the item.
String
The item’s product id.
Int!
required
The returned quantity.
String
The return reason.
String
The return reason code.
[String!]!
required
All return reason codes.
The conversation Redo had with the shopper to find their return reason. Null if the item did not go through the conversational return reason flow.
Show fields
Show fields
required
The messages the shopper saw, in order.
String
Generated summary of the conversation. Null until it has been generated.
[String!]!
required
All return reasons.
required
The refund for this item.
Show fields
Show fields
The compensation strategy (null for exchanges).
String
The item’s SKU.
The item’s processing status.
String
The item’s barcode/UPC.
String
The item’s variant id.
String!
required
The return’s legacy Mongo ObjectId (24-char hex), for cross-referencing v2 data.
required
required
The orders the returned items came from.Requires:
orders_readShow fields
Show fields
ArgumentsFields
String
Forward cursor — orders after this
edges[].cursor.String
Backward cursor — orders before this
edges[].cursor.Int
Forward pagination: the first N orders (max 100, default 25). Use with
after.Int
Backward pagination: the last N orders (max 100, default 25). Use with
before.required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
When the order was placed (the ecommerce provider’s creation time, falling back to Redo’s ingestion time).
String
The ISO 4217 currency code the order was placed in.
The customer who placed the order, if known.
String!
required
The order’s id in the source ecommerce platform.
required
The shipments fulfilling this order’s items.
ID!
required
The id of this order.
String!
required
The order’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
required
The items purchased on this order.
required
The Redo coverage the customer bought on this order.
The order’s shipping method, cost, and destination.
[String!]!
required
Free-form tags applied to the order.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.required
The Redo coverage behind this return and who it left paying for the label.
Show fields
Show fields
Boolean!
required
Whether any order on the return carried Redo coverage — returns coverage or package protection.
Boolean!
required
Whether any order on the return carried Redo final-sale returns coverage.
Who pays for the return label. Null before a payer is settled.
Why the label fell to that payer.
Boolean!
required
Whether any order on the return carried Redo package protection.
Boolean!
required
Whether any order on the return carried Redo returns coverage.
required
required
The shipment groups for the return; each carries its destination and shipments.
Show fields
Show fields
required
The address the group’s items are returned to.
String
The destination external location id, if any.
ID!
required
The id of this shipment group.
required
The return items assigned to this group’s label.
Show fields
Show fields
String!
required
Free-text comments the customer left for this item.
The item exchanged for this one, if an exchange.
String
A merchant-set external identifier for the item.
String
The external return line item id, if any.
String
The merchant-assigned grade.
Boolean
Whether the item is a green (keep-it) return.
ID!
required
The return item id.
required
Multiple-choice question answers for the item.
String
The id of the order line item this return item came from.
String
The merchant-assigned processing outcome.
[String!]!
required
Merchant-uploaded processing images.
String
Merchant processing notes.
String
The merchant price adjustment for the item.
String
The item’s product id.
The item’s product value: the per-item price after discounts, before tax and merchant adjustments.
Int!
required
The returned quantity.
String
The return reason.
String
The return reason code.
[String!]!
required
All return reason codes.
The conversation Redo had with the shopper to find their return reason. Null if the item did not go through the conversational return reason flow.
[String!]!
required
All return reasons.
required
The refund for this item.
String
The item’s SKU.
The item’s processing status.
String
The item’s barcode/UPC.
String
The item’s variant id.
The shipment fulfilling this group, if a label exists.Requires:
returns_readShow fields
Show fields
String
The carrier.
String
A URL to the customs/return form, if any.
ID!
required
The id of this shipment.
String
A URL to the postage label, if any.
String
The tracking status.
String
The tracking code.
String
A public tracking URL.
required
Who the return is from (the customer).
Show fields
Show fields
String
The customer’s email address.
The customer’s shipping address, if known.
required
String
A contact phone number for the customer.
required
The return’s current lifecycle status.
[String!]!
required
Tags applied to the return.
required
The monetary totals for the return.
Show fields
Show fields
required
What kind of return this is.
Example
query {
return(id: "...") {
compensationMethods
completeWithNoAction
createdAt
id
internalCreatedByName
legacyId
orders {
nodes {
createdAt
currencyCode
externalId
id
legacyId
tags
}
pageInfo { hasNextPage endCursor }
}
status
# ...
}
}