Struct OrderReturnLineItem

pub struct OrderReturnLineItem {

    pub uid: Option<String>,
    pub source_line_item_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 return_modifiers: Option<Vec<OrderReturnLineItemModifier>>,
    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_return_money: Option<Money>,
    pub total_tax_money: Option<Money>,
    pub total_discount_money: Option<Money>,
    pub total_money: Option<Money>,
}

The line item being returned in an order.

Fields

uid: Option<String>

A unique ID for this return line-item entry.

source_line_item_uid: Option<String>

The uid of the line item in the original sale order.

name: Option<String>

The name of the line item.

quantity: String

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”.

quantity_unit: Option<OrderQuantityUnit>

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

note: Option<String>

The note of the return line item.

catalog_object_id: Option<String>

The [CatalogItemVariation] ID applied to this return 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 return line item.

item_type: Option<OrderLineItemItemType>

The type of line item: an itemized return, a non-itemized return (custom amount), or the return of an unactivated gift card sale.

return_modifiers: Option<Vec<OrderReturnLineItemModifier>>

The [CatalogModifier]s applied to this line item.

applied_taxes: Option<Vec<OrderLineItemAppliedTax>>

The list of references to OrderReturnTax entities applied to the return line item. Each OrderLineItemAppliedTax has a tax_uid that references the uid of a top-level OrderReturnTax applied to the return line item. On reads, the applied amount is populated.

applied_discounts: Option<Vec<OrderLineItemAppliedDiscount>>

The list of references to OrderReturnDiscount entities applied to the return line item. Each OrderLineItemAppliedDiscount has a discount_uid that references the uid of a top-level OrderReturnDiscount applied to the return line item. On reads, the applied amount is populated.

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 returned in this line item. The price is calculated as base_price_money multiplied by quantity and does not include modifiers.

gross_return_money: Option<Money>

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

total_tax_money: Option<Money>

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

total_discount_money: Option<Money>

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

total_money: Option<Money>

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

Trait Implementations

impl Clone for OrderReturnLineItem

fn clone(&self) -> OrderReturnLineItem

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OrderReturnLineItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OrderReturnLineItem

fn default() -> OrderReturnLineItem

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderReturnLineItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderReturnLineItem

fn eq(&self, other: &OrderReturnLineItem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for OrderReturnLineItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OrderReturnLineItem

impl StructuralPartialEq for OrderReturnLineItem