# The return line item object

A return line item object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/return_line_items` endpoint.

## Fields

| Field                                   | Type       | Description                                                                                                                                                                                         |
| --------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **type**                                | `string`   | `return_line_items`                                                                                                                                                                                 |
| **id**                                  | `string`   | The return line item unique identifier                                                                                                                                                              |
| links.**self**                          | `string`   | The return line item endpoint URL                                                                                                                                                                   |
| attributes.**sku\_code**                | `string`   | The code of the associated SKU.                                                                                                                                                                     |
| attributes.**bundle\_code**             | `string`   | The code of the associated bundle.                                                                                                                                                                  |
| attributes.**quantity**                 | `integer`  | The return line item quantity.                                                                                                                                                                      |
| attributes.**name**                     | `string`   | The name of the line item.                                                                                                                                                                          |
| attributes.**image\_url**               | `string`   | The image\_url of the associated line item.                                                                                                                                                         |
| attributes.**total\_amount\_cents**     | `integer`  | Calculated as line item unit amount x returned quantity and applied discounts, if any.                                                                                                              |
| attributes.**total\_amount\_float**     | `float`    | The return line item total amount, float. This can be useful to track the purchase on thrid party systems, e.g Google Analyitcs Enhanced Ecommerce.                                                 |
| attributes.**formatted\_total\_amount** | `string`   | The return line item total amount, formatted. This can be useful to display the amount with currency in you views.                                                                                  |
| attributes.**\_restock**                | `boolean`  | Send this attribute if you want to restock the line item.                                                                                                                                           |
| attributes.**return\_reason**           | `object`   | Set of key-value pairs that you can use to add details about return reason.                                                                                                                         |
| attributes.**restocked\_at**            | `datetime` | Time at which the return line item was restocked.                                                                                                                                                   |
| attributes.**created\_at**              | `datetime` | Time at which the resource was created.                                                                                                                                                             |
| attributes.**updated\_at**              | `datetime` | Time at which the resource was last updated.                                                                                                                                                        |
| attributes.**reference**                | `string`   | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
| attributes.**reference\_origin**        | `string`   | Any identifier of the third party system that defines the reference code.                                                                                                                           |
| attributes.**metadata**                 | `object`   | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.                                        |
| relationships.**return**                | `object`   | The associated return.                                                                                                                                                                              |
| relationships.**line\_item**            | `object`   | The associated line item.                                                                                                                                                                           |
| relationships.**event\_stores**         | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                           | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |