Object Index / Definition

You are viewing an old version of the API
OrderReturnLineItemModifier

Beta

A line item modifier being returned.

Properties

Name Description
uid
string

Unique ID that identifies the return modifier only within this order.

Max Length 60
source_modifier_uid
string

uid of the Modifier from the LineItem from the Order which contains the original sale of this line item modifier.

Max Length 60
catalog_object_id
string

The catalog object id referencing CatalogModifier.

Max Length 192
name
string

The name of the item modifier.

Max Length 255
base_price_money
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 will override the predefined CatalogModifier price.

total_price_money
Money

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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?