pub struct OrderLineItem {Show 20 fields
pub uid: Option<String>,
pub name: Option<String>,
pub quantity: String,
pub quantity_unit: Option<OrderQuantityUnit>,
pub note: Option<String>,
pub catalog_object_id: Option<String>,
pub catalog_version: Option<i64>,
pub variation_name: Option<String>,
pub item_type: Option<OrderLineItemItemType>,
pub metadata: Option<HashMap<String, String>>,
pub modifiers: Option<Vec<OrderLineItemModifier>>,
pub applied_taxes: Option<Vec<OrderLineItemAppliedTax>>,
pub applied_discounts: Option<Vec<OrderLineItemAppliedDiscount>>,
pub base_price_money: Option<Money>,
pub variation_total_price_money: Option<Money>,
pub gross_sales_money: Option<Money>,
pub total_tax_money: Option<Money>,
pub total_discount_money: Option<Money>,
pub total_money: Option<Money>,
pub pricing_blocklists: Option<OrderLineItemPricingBlocklists>,
}
Expand description
Represents a line item in an order.
Each line item describes a different product to purchase, with its own quantity and price details.
Fields§
§uid: Option<String>
A unique ID that identifies the line item only within this order.
name: Option<String>
The name of the line item.
quantity: String
The quantity purchased, formatted as a decimal number. For example, “3”.
Line items with a quantity of “0” are automatically removed when paying for or otherwise completing the order.
Line items with a quantity_unit
can have non-integer quantities. For example, “1.70000”.
quantity_unit: Option<OrderQuantityUnit>
The unit and precision that this line item’s quantity is measured in.
note: Option<String>
The note of the line item.
catalog_object_id: Option<String>
The [CatalogItemVariation] ID applied to this line item.
catalog_version: Option<i64>
The version of the catalog object that this line item references.
variation_name: Option<String>
The name of the variation applied to this line item.
item_type: Option<OrderLineItemItemType>
The type of line item: an itemized sale, a non-itemized sale (custom amount), or the activation or reloading of a gift card.
metadata: Option<HashMap<String, String>>
Application-defined data attached to this order. 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
[a-zA-Z0-9_-]
. Entries can also include metadata generated by Square. These keys are
prefixed with a namespace, separated from the key with a ‘:’ character.
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: Option<Vec<OrderLineItemModifier>>
The [CatalogModifier]s applied to this line item.
applied_taxes: Option<Vec<OrderLineItemAppliedTax>>
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
is 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.
applied_discounts: Option<Vec<OrderLineItemAppliedDiscount>>
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
is 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.
base_price_money: Option<Money>
The base price for a single unit of the line item.
variation_total_price_money: Option<Money>
Read only The total price of all item variations sold in this line item. The price is
calculated as base_price_money
multiplied by quantity
. It does not include modifiers.
gross_sales_money: Option<Money>
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_tax_money: Option<Money>
Read only The total amount of tax money to collect for the line item.
total_discount_money: Option<Money>
Read only The total amount of discount money to collect for the line item.
total_money: Option<Money>
Read only The total amount of money to collect for this line item.
pricing_blocklists: Option<OrderLineItemPricingBlocklists>
Describes pricing adjustments that are blocked from manual and automatic application to a line item. For more information, see Apply Taxes and Discounts.
Trait Implementations§
Source§impl Clone for OrderLineItem
impl Clone for OrderLineItem
Source§fn clone(&self) -> OrderLineItem
fn clone(&self) -> OrderLineItem
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OrderLineItem
impl Debug for OrderLineItem
Source§impl Default for OrderLineItem
impl Default for OrderLineItem
Source§fn default() -> OrderLineItem
fn default() -> OrderLineItem
Source§impl<'de> Deserialize<'de> for OrderLineItem
impl<'de> Deserialize<'de> for OrderLineItem
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for OrderLineItem
impl PartialEq for OrderLineItem
Source§impl Serialize for OrderLineItem
impl Serialize for OrderLineItem
impl Eq for OrderLineItem
impl StructuralPartialEq for OrderLineItem
Auto Trait Implementations§
impl Freeze for OrderLineItem
impl RefUnwindSafe for OrderLineItem
impl Send for OrderLineItem
impl Sync for OrderLineItem
impl Unpin for OrderLineItem
impl UnwindSafe for OrderLineItem
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.