Object Index / Definition

You are viewing an old version of the API
Order​Return​Line​Item

Beta

The line item being returned in an Order

Properties

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

Max Length 12 Min Length 1
applied_discounts
Order​Line​Item​Applied​Discount [ ]

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.

applied_taxes
Order​Line​Item​Applied​Tax [ ]

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.

base_price_money
Money

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

catalog_object_id
string

The CatalogItemVariation id applied to this returned line item.

Max Length 192
gross_return_money
Money

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

name
string

The name of the line item.

Max Length 500
note
string

The note of the returned line item.

Max Length 500
quantity_unit
Order​Quantity​Unit

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

return_modifiers
Order​Return​Line​Item​Modifier [ ]

The CatalogModifiers applied to this line item.

source_line_item_uid
string

uid of the LineItem in the original sale Order.

Max Length 60
total_discount_money
Money

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

total_money
Money

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

total_tax_money
Money

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

uid
string

Unique identifier for this return line item entry.

Max Length 60
variation_name
string

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

Max Length 255
variation_total_price_money
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.

return_discounts
Order​Return​Discount [ ]

Deprecated

A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any return-level discounts apportioned to this item.

This field has been deprecated in favour of applied_discounts.

return_taxes
Order​Return​Tax [ ]

Deprecated

A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any return-level taxes apportioned to this item.

This field has been deprecated in favour of applied_taxes.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?