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

---
title: "OrderReturn"
description: "Represents return details of an order that a customer places for a product."
---

## Fields

***

<ParamField path="id" type="ID!" required>
  The return id generated when a return is requested.
</ParamField>

<ParamField path="orderId" type="ID!" required>
  The Rye order id associated with the return.
</ParamField>

<ParamField path="shippingLabelUrl" type="String" required>
  When a return has been apporved this represents the shipping label url that can be forwarded to the customer.
</ParamField>

<ParamField path="updatedAt" type={<a href="/api-reference/time">Time!</a>} required>
  Date when return was last updated.
</ParamField>

<ParamField path="createdAt" type={<a href="/api-reference/time">Time!</a>} required>
  Time return was first created.
</ParamField>

<ParamField path="marketplace" type={<a href="/api-reference/marketplace">Marketplace!</a>} required>
  Which marketplace the return was created on.
</ParamField>

<ParamField path="marketplaceOrderId" type="String!" required>
  Order id from the marketplace.
</ParamField>

<ParamField path="lineItems" type={<a href="/api-reference/returnlineitem">[ReturnLineItem!]!</a>}>
  Line items associated with the return. See [ReturnLineItem](/api-reference/returnlineitem) for more details.
</ParamField>

## Related types

* [`Order`](/api-reference/order)


---

*Powered by [holocron.so](https://holocron.so)*