Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

Fields


path idID!required
The return id generated when a return is requested.
path orderIdID!required
The Rye order id associated with the return.
path shippingLabelUrlStringrequired
When a return has been apporved this represents the shipping label url that can be forwarded to the customer.
path updatedAtTime!required
Date when return was last updated.
path createdAtTime!required
Time return was first created.
path marketplaceMarketplace!required
Which marketplace the return was created on.
path marketplaceOrderIdString!required
Order id from the marketplace.
path lineItems[ReturnLineItem!]!
Line items associated with the return. See ReturnLineItem for more details.

Related types