<- Object

Object

OrderReturnLineItemModifierBeta

A line item modifier being returned.

Link to section

Properties

Link to section

uid

string

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

Link to section

source_modifier_uid

string

The modifier uid from the order's line item that contains the original sale of this line item modifier.

Link to section

catalog_object_id

string

Link to section

catalog_version

integer(64-bit)

The version of the catalog object that this line item modifier references.

Link to section

name

string

The name of the item modifier.

Link to section

base_price_money

The 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 overrides the predefined CatalogModifier price.

Link to section

total_price_money

Read only The 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.

Link to section

quantity

string

The quantity of the line item modifier. The modifier quantity can be 0 or more. For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders this item, the restaurant records the purchase by creating an Order object with a line item for a burger. The line item includes a line item modifier: the name is cheese and the quantity is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses the extra cheese option, the modifier quantity increases to 2. If the buyer does not want any cheese, the modifier quantity is set to 0.