• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
OrderReturnLineItem BETA

The line item being returned in an Order.

Properties

Name Description
uid
string

Unique identifier for this return line item entry.

Max Length 60
source_line_item_uid
string

uid of the LineItem in the original sale Order.

Max Length 60
name
string

The name of the line item.

Max Length 500
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
quantity_unit
OrderQuantityUnit

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

note
string

The note of the returned line item.

Max Length 500
catalog_object_id
string

The CatalogItemVariation id applied to this returned line item.

Max Length 192
variation_name
string

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

Max Length 255
return_modifiers
OrderReturnLineItemModifier [ ]

The CatalogModifiers applied to this line item.

applied_taxes
OrderLineItemAppliedTax [ ]

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.

applied_discounts
OrderLineItemAppliedDiscount [ ]

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.

base_price_money
Money

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

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.

gross_return_money
Money

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

total_tax_money
Money

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

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.

Share Feedback

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