Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
33 lines (26 loc) · 3.74 KB

OrderReturnLineItem.md

File metadata and controls

33 lines (26 loc) · 3.74 KB

OrderReturnLineItem

Description

The line item being returned in an Order. Note: This model is in beta.

Properties

Name Type Description Notes
uid String Unique identifier for this return line item entry. [optional]
sourceLineItemUid String `uid` of the LineItem in the original sale Order. [optional]
name String The name of the line item. [optional]
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"`.
quantityUnit OrderQuantityUnit The unit and precision that this return line item's quantity is measured in. [optional]
note String The note of the returned line item. [optional]
catalogObjectId String The `CatalogItemVariation` id applied to this returned line item. [optional]
variationName String The name of the variation applied to this returned line item. [optional]
returnModifiers List<OrderReturnLineItemModifier> The `CatalogModifier`s applied to this line item. [optional]
returnTaxes List<OrderReturnTax> A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any return-level taxes apportioned to this item. This field has been deprecated in favour of `applied_taxes`. [optional] [deprecated]
returnDiscounts List<OrderReturnDiscount> A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any return-level discounts apportioned to this item. This field has been deprecated in favour of `applied_discounts`. [optional] [deprecated]
appliedTaxes List<OrderLineItemAppliedTax> The list of references to `OrderReturnTax` entities applied to the returned line item. Each `OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level `OrderReturnTax` applied to the returned line item. On reads, the amount applied is populated. [optional]
appliedDiscounts List<OrderLineItemAppliedDiscount> The list of references to `OrderReturnDiscount` entities applied to the returned line item. Each `OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level `OrderReturnDiscount` applied to the returned line item. On reads, the amount applied is populated. [optional]
basePriceMoney Money The base price for a single unit of the line item. [optional]
variationTotalPriceMoney Money The total price of all item variations returned in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers. [optional]
grossReturnMoney Money The gross return amount of money calculated as (item base price + modifiers price) * quantity. [optional]
totalTaxMoney Money The total tax amount of money to return for the line item. [optional]
totalDiscountMoney Money The total discount amount of money to return for the line item. [optional]
totalMoney Money The total amount of money to return for this line item. [optional]