Struct OrderReturn

pub struct OrderReturn {
    pub uid: Option<String>,
    pub source_order_id: Option<String>,
    pub return_line_items: Option<Vec<OrderReturnLineItem>>,
    pub return_service_charges: Option<Vec<OrderReturnServiceCharge>>,
    pub return_taxes: Option<Vec<OrderReturnTax>>,
    pub return_discounts: Option<Vec<OrderReturnDiscount>>,
    pub rounding_adjustment: Option<OrderRoundingAdjustment>,
    pub return_amounts: Option<OrderMoneyAmounts>,
}

The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.

Fields

uid: Option<String>

A unique ID that identifies the return only within this order.

source_order_id: Option<String>

An order that contains the original sale of these return line items. This is unset for unlinked returns.

return_line_items: Option<Vec<OrderReturnLineItem>>

A collection of line items that are being returned.

return_service_charges: Option<Vec<OrderReturnServiceCharge>>

Read only A collection of service charges that are being returned.

return_taxes: Option<Vec<OrderReturnTax>>

A collection of references to taxes being returned for an order, including the total applied tax amount to be returned. The taxes must reference a top-level tax ID from the source order.

return_discounts: Option<Vec<OrderReturnDiscount>>

A collection of references to discounts being returned for an order, including the total applied discount amount to be returned. The discounts must reference a top-level discount ID from the source order.

rounding_adjustment: Option<OrderRoundingAdjustment>

A positive or negative rounding adjustment to the total value being returned. Adjustments are commonly used to apply cash rounding when the minimum unit of the account is smaller than the lowest physical denomination of the currency.

return_amounts: Option<OrderMoneyAmounts>

An aggregate monetary value being returned by this return entry.

Trait Implementations

impl Clone for OrderReturn

fn clone(&self) -> OrderReturn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderReturn

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

Formats the value using the given formatter.

impl Default for OrderReturn

fn default() -> OrderReturn

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderReturn

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderReturn

fn eq(&self, other: &OrderReturn) -> 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 OrderReturn

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 OrderReturn

impl StructuralPartialEq for OrderReturn