Object Index

You are viewing an old version of the API

2023-03-15

Version 2023-03-15

• All Versions

OrderReturnLineItem BETA

A unique ID for this return line-item entry.

The uid of the line item in the original sale order.

The name of the line item.

The quantity returned, formatted as a decimal number. For example, "3".

Line items with a quantity_unit can have non-integer quantities. For example, "1.70000".

The unit and precision that this return line item's quantity is measured in.

The note of the return line item.

The CatalogItemVariation ID applied to this return line item.

The version of the catalog object that this line item references.

The name of the variation applied to this return line item.

The type of line item: an itemized return, a non-itemized return (custom amount), or the return of an unactivated gift card sale.

The CatalogModifiers applied to this line item.

The list of references to OrderReturnTax entities applied to the return line item. Each OrderLineItemAppliedTax has a tax_uid that references the uid of a top-level OrderReturnTax applied to the return line item. On reads, the applied amount is populated.

The list of references to OrderReturnDiscount entities applied to the return line item. Each OrderLineItemAppliedDiscount has a discount_uid that references the uid of a top-level OrderReturnDiscount applied to the return line item. On reads, the applied amount is populated.

The base price for a single unit of the line item.

Read only The total price of all item variations returned in this line item. The price is calculated as base_price_money multiplied by quantity and does not include modifiers.

Read only The gross return amount of money calculated as (item base price + modifiers price) * quantity.

Read only The total amount of tax money to return for the line item.

Read only The total amount of discount money to return for the line item.

Read only The total amount of money to return for this line item.