<- Object

Object

All versions ->

OrderReturnLineItemBeta

The line item being returned in an order.

Link to section

Properties

Link to section

uid

string

A unique ID for this return line-item entry.

Link to section

source_line_item_uid

string

The uid of the line item 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 return line item.

Link to section

catalog_object_id

string

Link to section

catalog_version

integer(64-bit)

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

Link to section

variation_name

string

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

Link to section

item_type

string

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

Link to section

return_modifiers

Link to section

applied_taxes

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.

Link to section

applied_discounts

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.

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. The price is calculated as base_price_money multiplied by quantity and 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 amount of tax money to return for the line item.

Link to section

total_discount_money

Read only The total amount of discount 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.

Link to section

applied_service_charges

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

Link to section

total_service_charge_money

Read only The total amount of apportioned service charge money to return for the line item.