<- Object

Object

All versions ->

OrderReturnLineItemBeta

The line item being returned in an Order.

Link to section

Properties

Link to section

uid

string

Unique identifier for this return line item entry.

Link to section

source_line_item_uid

string

uid of the LineItem in the original sale Order.

Link to section

name

string

The name of the line item.

Link to section

quantity

string

Required

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".

Link to section

quantity_unit

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

Link to section

note

string

The note of the returned line item.

Link to section

catalog_object_id

string

Link to section

variation_name

string

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

Link to section

return_modifiers

Link to section

applied_taxes

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

Link to section

applied_discounts

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

Link to section

base_price_money

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

Link to section

variation_total_price_money

Read only The total price of all item variations returned in this line item. Calculated as base_price_money multiplied by quantity. Does not include modifiers.

Link to section

gross_return_money

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

Link to section

total_tax_money

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

Link to section

total_discount_money

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

Link to section

total_money

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