SquareConnect::OrderLineItem

Description

Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.

Properties

Name	Type	Description	Notes
uid	String	Unique ID that identifies the line item only within this order. This field is read-only.	[optional]
name	String	The name of the line item.	[optional]
quantity	String	The quantity purchased, formatted as a decimal number. For example: `"3"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `"1.70000"`.
quantity_unit	OrderQuantityUnit	The unit and precision that this line item's quantity is measured in.	[optional]
note	String	The note of the line item.	[optional]
catalog_object_id	String	The CatalogItemVariation id applied to this line item.	[optional]
variation_name	String	The name of the variation applied to this line item.	[optional]
modifiers	Array<OrderLineItemModifier>	The CatalogModifiers applied to this line item.	[optional]
taxes	Array<OrderLineItemTax>	A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list.	[optional]
discounts	Array<OrderLineItemDiscount>	A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list.	[optional]
base_price_money	Money	The base price for a single unit of the line item.	[optional]
variation_total_price_money	Money	The total price of all item variations sold in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers.	[optional]
gross_sales_money	Money	The amount of money made in gross sales for this line item. Calculated as the sum of the variation's total price and each modifier's total price. This field is read-only.	[optional]
total_tax_money	Money	The total tax amount of money to collect for the line item. This field is read-only.	[optional]
total_discount_money	Money	The total discount amount of money to collect for the line item. This field is read-only.	[optional]
total_money	Money	The total amount of money to collect for this line item. This field is read-only.	[optional]