Object Index
You are viewing an old version of the API
OrderLineItem
Object Index
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 | Description |
---|---|
uid
Beta
|
A unique ID that identifies the line item only within this order. |
name
|
The name of the line item. |
quantity
Required
|
The quantity purchased, formatted as a decimal number.
For example, Line items with a quantity of Line items with a |
quantity_
|
The unit and precision that this line item's quantity is measured in. |
note
|
The note of the line item. |
catalog_
|
The CatalogItemVariation ID applied to this line item. |
catalog_
|
The version of the catalog object that this line item references. |
variation_
|
The name of the variation applied to this line item. |
item_
|
The type of line item: an itemized sale, a non-itemized sale (custom amount), or the activation or reloading of a gift card. |
metadata
Beta
|
Application-defined data attached to this line item. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details). Keys written by applications must be 60 characters or less and must be in the character set
Values have a maximum length of 255 characters. An application can have up to 10 entries per metadata field. Entries written by applications are private and can only be read or modified by the same application. For more information, see Metadata. |
modifiers
|
The CatalogModifiers applied to this line item. |
applied_
Beta
|
The list of references to taxes applied to this line item. Each
An To change the amount of a tax, modify the referenced top-level tax. |
applied_
Beta
|
The list of references to discounts applied to this line item. Each
An To change the amount of a discount, modify the referenced top-level discount. |
base_
|
The base price for a single unit of the line item. |
variation_
|
Read only The total price of all item variations sold in this line item.
The price is calculated as |
gross_
|
Read only The amount of money made in gross sales for this line item. The amount is calculated as the sum of the variation's total price and each modifier's total price. |
total_
|
Read only The total amount of tax money to collect for the line item. |
total_
|
Read only The total amount of discount money to collect for the line item. |
total_
|
Read only The total amount of money to collect for this line item. |
pricing_
Beta
|
Describes pricing adjustments that are blocked from manual and automatic application to a line item. For more information, see Apply Taxes and Discounts. |