Interface ShoppingListRemoveTextLineItemAction

interface ShoppingListRemoveTextLineItemAction {
    action: "removeTextLineItem";
    quantity?: number;
    textLineItemId?: string;
    textLineItemKey?: string;
}

Properties

action quantity? textLineItemId? textLineItemKey?

Properties

Readonlyaction

action: "removeTextLineItem"

Optional Readonlyquantity

quantity?: number

Amount to remove from the quantity of the TextLineItem. If not set, the TextLineItem is removed from the ShoppingList. If this value matches or exceeds the current quantity of the TextLineItem, the TextLineItem is removed from the ShoppingList.

Optional ReadonlytextLineItemId

textLineItemId?: string

The id of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Optional ReadonlytextLineItemKey

textLineItemKey?: string

The key of the TextLineItem to update. Either lineItemId or lineItemKey is required.

Settings

Member Visibility

On This Page

Properties