Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 3.6 KB

MenuItem.md

File metadata and controls

50 lines (34 loc) · 3.6 KB
Raw

MenuItem

Properties

Name Type Description Notes
id String The item's ID in the partner system.
name String The name of the item.
nameTranslation Map<String, String> Translation of the item name. Only support up to 1 translated language. Refer Menu Translation. [optional]
availableStatus AvailableStatusEnum The status for the item that is in the category. Note: In order to set an item as &quot;UNAVAILABLE&quot;, it is required to update both the `availableStatus` and `maxStock` fields, whereby the `maxStock` value should be set to 0.
description String The description of the item. There is a custom length limit of 2000 for `VN`. [optional]
descriptionTranslation Map<String, String> Translation of the item description. Only support up to 1 translated language. Refer Menu Translation. [optional]
price Long The item's price (excluding tax) in minor format. For example: 1900 means $19 with `currency.exponent` as 2. Refer to FAQ for more details.
photos List<String> An array string for the item’s image URL links. Refer to FAQs for more details about images. [optional]
specialType SpecialTypeEnum The item's special Tag. Refer to FAQs for more details about specialType. [optional]
taxable Boolean For Indonesia only. This field allows the configuration for an item to be marked as tax applicable, and marked item would then be included in a commercial invoice to consumers as per the government's regulations. [optional]
barcode String The barcode Number (GTIN). Max 64 allowed. GTIN must be 8, 12, 13, 14 numeric digits. [optional]
sellingTimeID String The selling time's ID for the item. This value overwrites the category's selling time if it is different. Empty value implies the category's selling time will be applied. [optional]
maxStock Long Available stocks under inventory for this item. Auto reduce when there is order placed for this item. Empty value implies no limit. Note: It is necessary to set `maxStock` to 0 if the `availableStatus` of the item is &quot;UNAVAILABLE&quot;. Item will be set to &quot;AVAILABLE&quot; if `maxStock` > 0. [optional]
advancedPricing AdvancedPricing [optional]
purchasability Purchasability [optional]
modifierGroups List<ModifierGroup> An array of the modifierGroup JSON objects. Max 30 allowed per item. Refer to Modifier groups for more information. [optional]

Enum: AvailableStatusEnum

Name Value
AVAILABLE "AVAILABLE"
UNAVAILABLE "UNAVAILABLE"
HIDE "HIDE"
UNAVAILABLETODAY "UNAVAILABLETODAY"
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"

Enum: SpecialTypeEnum

Name Value
ALCOHOL "alcohol"
EMPTY ""
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"