OrderReturnLineItemModifier

October 23, 2019 ยท View on GitHub

Description

A line item modifier being returned. Note: This model is in beta.

Properties

NameTypeDescriptionNotes
uidStringUnique ID that identifies the return modifier only within this order.[optional]
sourceModifierUidString`uid` of the Modifier from the LineItem from the Order which contains the original sale of this line item modifier.[optional]
catalogObjectIdStringThe catalog object id referencing `CatalogModifier`.[optional]
nameStringThe name of the item modifier.[optional]
basePriceMoneyMoneyThe base price for the modifier. `base_price_money` is required for ad hoc modifiers. If both `catalog_object_id` and `base_price_money` are set, `base_price_money` will override the predefined `CatalogModifier` price.[optional]
totalPriceMoneyMoneyThe total price of the item modifier for its line item. This is the modifier's `base_price_money` multiplied by the line item's quantity.[optional]