Class Item

Items

Hierarchy

Implements

Constructors

Properties

_timestamp: number
add_credit: number = 0

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 = 0

Cost of the item

created_at: Date = ...
deleted_at: any = null
description: string

description of the object

description_translations: {} = {}

Translations of the description

Type declaration

    discountable: boolean = true

    Indicates whether the item is discountable

    dislikes: number = 0
    etc: {} = {}

    Type declaration

      icon: string = ''

      icon of the object

      id_in_server: number
      image_file_path: string = ''

      image file path

      image_thumbnail_file_path: string = ''

      image thumbnail file path

      image_thumbnail_url: string = ''
      image_url: string = ''

      Rank of the item

      is_credit_reward_exempt: boolean = false

      Indicates whether the item is credit reward exempt

      is_point_reward_exempt: boolean = false

      Indicates whether the item is point reward exempt

      is_service_charge_exempt: boolean = false

      Indicates whether the item is service charge exempt

      is_tax_exempt: boolean = false

      Indicates whether the item is tax exempt

      kitchen_printers_uids: any[] = []

      Kitchen printer IDs of the item

      likes: number = 0
      meta: {} = {}

      Type declaration

        minus_point: number = 0

        how many points will be used to purchase the item

        name: string

        name of the object

        name_translations: any

        Translations of the name

        open_editor: boolean = true

        if editor will be opened by default when item is clicked

        order_printers_uids: any[] = []

        Order printer IDs of the item

        price: number = 0

        The price of the item.

        price_adjustable: boolean = false

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

        print_on_receipt: boolean = true

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

        printing_sequence: number = 0
        recipe: string = ''

        Recipe of the item

        sequence: number = 0
        sku: string = ''

        The SKU (stock keeping unit) of the item.

        sold: number = 0
        stock: number = 0
        subcategory_uid: string = ''

        Subcategory ID of the item

        type: ProductType = ProductType.ByQuantity

        The type of product.

        uid: string = ...
        unit: number = 0
        updated_at: Date = ...

        Generated using TypeDoc