OrderLineItem.md — WooCommerce Square 2.2.5

woocommerce-square / vendor / square / connect / docs / Model / OrderLineItem.md

woocommerce-square / vendor / square / connect / docs / Model Last commit date

OrderLineItem.md

33 lines

1	# OrderLineItem
2
3	### Description
4
5	Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.
6
7	## Properties
8	Name \| Getter \| Setter \| Type \| Description \| Notes
9	------------ \| ------------- \| ------------- \| ------------- \| ------------- \| -------------
10	uid \| getUid() \| setUid($value) \| string \| Unique ID that identifies the line item only within this order. \| [optional]
11	name \| getName() \| setName($value) \| string \| The name of the line item. \| [optional]
12	quantity \| getQuantity() \| setQuantity($value) \| 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\"`. \|
13	quantity_unit \| getQuantityUnit() \| setQuantityUnit($value) \| [](OrderQuantityUnit.md\SquareConnect\Model\OrderQuantityUnit](OrderQuantityUnit.md](OrderQuantityUnit.md) \| The unit and precision that this line item's quantity is measured in. \| [optional]
14	note \| getNote() \| setNote($value) \| string \| The note of the line item. \| [optional]
15	catalog_object_id \| getCatalogObjectId() \| setCatalogObjectId($value) \| string \| The [](#type-catalogitemvariationCatalogItemVariation](#type-catalogitemvariation](#type-catalogitemvariation) id applied to this line item. \| [optional]
16	variation_name \| getVariationName() \| setVariationName($value) \| string \| The name of the variation applied to this line item. \| [optional]
17	modifiers \| getModifiers() \| setModifiers($value) \| [](OrderLineItemModifier.md\SquareConnect\Model\OrderLineItemModifier[]](OrderLineItemModifier.md](OrderLineItemModifier.md) \| The [](#type-catalogmodifierCatalogModifier](#type-catalogmodifier](#type-catalogmodifier)s applied to this line item. \| [optional]
18	taxes \| getTaxes() \| setTaxes($value) \| [](OrderLineItemTax.md\SquareConnect\Model\OrderLineItemTax[]](OrderLineItemTax.md](OrderLineItemTax.md) \| 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. This field has been deprecated in favour of `applied_taxes`. Usage of both this field and `applied_taxes` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error. \| [optional]
19	discounts \| getDiscounts() \| setDiscounts($value) \| [](OrderLineItemDiscount.md\SquareConnect\Model\OrderLineItemDiscount[]](OrderLineItemDiscount.md](OrderLineItemDiscount.md) \| 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. This field has been deprecated in favour of `applied_discounts`. Usage of both this field and `applied_discounts` when creating an order will result in an error. Usage of this field when sending requests to the UpdateOrder endpoint will result in an error. \| [optional]
20	applied_taxes \| getAppliedTaxes() \| setAppliedTaxes($value) \| [](OrderLineItemAppliedTax.md\SquareConnect\Model\OrderLineItemAppliedTax[]](OrderLineItemAppliedTax.md](OrderLineItemAppliedTax.md) \| The list of references to taxes applied to this line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderLineItemTax` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedTax` will be automatically created on every line item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax` records for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any line items. To change the amount of a tax, modify the referenced top-level tax. \| [optional]
21	applied_discounts \| getAppliedDiscounts() \| setAppliedDiscounts($value) \| [](OrderLineItemAppliedDiscount.md\SquareConnect\Model\OrderLineItemAppliedDiscount[]](OrderLineItemAppliedDiscount.md](OrderLineItemAppliedDiscount.md) \| The list of references to discounts applied to this line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderLineItemDiscounts` applied to the line item. On reads, the amount applied is populated. An `OrderLineItemAppliedDiscount` will be automatically created on every line item for all `ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any line items. To change the amount of a discount, modify the referenced top-level discount. \| [optional]
22	base_price_money \| getBasePriceMoney() \| setBasePriceMoney($value) \| [](Money.md\SquareConnect\Model\Money](Money.md](Money.md) \| The base price for a single unit of the line item. \| [optional]
23	variation_total_price_money \| getVariationTotalPriceMoney() \| setVariationTotalPriceMoney($value) \| [](Money.md\SquareConnect\Model\Money](Money.md](Money.md) \| 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]
24	gross_sales_money \| getGrossSalesMoney() \| setGrossSalesMoney($value) \| [](Money.md\SquareConnect\Model\Money](Money.md](Money.md) \| 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. \| [optional]
25	total_tax_money \| getTotalTaxMoney() \| setTotalTaxMoney($value) \| [](Money.md\SquareConnect\Model\Money](Money.md](Money.md) \| The total tax amount of money to collect for the line item. \| [optional]
26	total_discount_money \| getTotalDiscountMoney() \| setTotalDiscountMoney($value) \| [](Money.md\SquareConnect\Model\Money](Money.md](Money.md) \| The total discount amount of money to collect for the line item. \| [optional]
27	total_money \| getTotalMoney() \| setTotalMoney($value) \| [](Money.md\SquareConnect\Model\Money](Money.md](Money.md) \| The total amount of money to collect for this line item. \| [optional]
28
29	Note: All properties are protected and only accessed via getters and setters.
30
31	[](../../README.md#documentation-for-models[Back to Model list]](../../README.md#documentation-for-models](../../README.md#documentation-for-models) [](../../README.md#documentation-for-api-endpoints[Back to API list]](../../README.md#documentation-for-api-endpoints](../../README.md#documentation-for-api-endpoints) [](../../README.md[Back to README]](../../README.md](../../README.md)
32
33