Interface IItem

Items

Hierarchy

Implemented by

Properties

add_credit: number

Credit value of the item

barcode: string

The barcode of the item.

category_uid: string

The unique identifier of the category that the item belongs to.

codename: string

Codename of the item

color: string

color of the object

cost: number

Cost of the item

description: string

description of the object

description_translations: Record<string, string>

Translations of the description

discountable: boolean

Indicates whether the item is discountable

icon: string

icon of the object

image_file_path: string

image file path

image_thumbnail_file_path: string

image thumbnail file path

image_url: string

Rank of the item

is_credit_reward_exempt: boolean

Indicates whether the item is credit reward exempt

is_point_reward_exempt: boolean

Indicates whether the item is point reward exempt

is_service_charge_exempt: boolean

Indicates whether the item is service charge exempt

is_tax_exempt: boolean

Indicates whether the item is tax exempt

kitchen_printers_uids: string[]

Kitchen printer IDs of the item

minus_point: number

how many points will be used to purchase the item

modifier_categories?: ICoreCategory[]

Modifier Group IDs of the item

modifiers?: ICoreItem[]

Modifier IDs of the item

name: string

name of the object

name_translations: Record<string, string>

Translations of the name

open_editor: boolean

if editor will be opened by default when item is clicked

order_printers_uids: string[]

Order printer IDs of the item

price: number

The price of the item.

price_adjustable: boolean

Whether or not the price of the item can be adjusted.

print_on_receipt: boolean

Whether or not the item should be printed on the receipt.

recipe: string

Recipe of the item

sequence: number
sku: string

The SKU (stock keeping unit) of the item.

subcategory_uid: string

Subcategory ID of the item

The type of product.

Generated using TypeDoc