The return line item object
A comprehensive list of the return line item resource's attributes and relationships
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 |
|
|
id |
| The return line item unique identifier |
links.self |
| The return line item endpoint URL |
attributes._restock |
| Send this attribute if you want to restock the line item. |
attributes.bundle_code |
| The code of the associated bundle. |
attributes.created_at |
| Time at which the resource was created. |
attributes.formatted_total_amount |
| The return line item total amount, formatted. This can be useful to display the amount with currency in you views. |
attributes.image_url |
| The image_url of the associated line item. |
attributes.metadata |
| 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. |
attributes.name |
| The name of the line item. |
attributes.quantity |
| The return line item quantity. |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code. |
attributes.restocked_at |
| Time at which the return line item was restocked. |
attributes.return_reason |
| Set of key-value pairs that you can use to add details about return reason. |
attributes.sku_code |
| The code of the associated SKU. |
attributes.total_amount_cents |
| Calculated as line item unit amount x returned quantity and applied discounts, if any. |
attributes.total_amount_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.updated_at |
| Time at which the resource was last updated. |
relationships.line_item |
| The associated line item. |
relationships.return |
| The associated return. |
meta.mode |
| The resource environment (can be one of |
Last updated