Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.73 KB

UpdateMenuRequest.md

File metadata and controls

42 lines (26 loc) · 2.73 KB
Raw

UpdateMenuRequest

Properties

Name Type Description Notes
merchantID String The merchant's ID that is in GrabFood's database.
field FieldEnum The record type that you want to update.
id String The record's ID on the partner system. For example, the modifier id in case type is MODIFIER.
price Long The record's price in minor unit format. [optional]
availableStatus AvailableStatusEnum The record's availableStatus. [optional]
maxStock Long Available stocks under inventory for this item. Auto reduce when there is order placed for this item. Note: It is necessary to set `maxStock` to 0 if the `availableStatus` of the item is "UNAVAILABLE". Item will be set to "AVAILABLE" if `maxStock` > 0. [optional]
advancedPricings List<UpdateAdvancedPricing> Price configuration (in minor unit) for different service, order type and channel combination. If a service type does not have a specified price, it will utilize the default price of the item. [optional]
purchasabilities List<UpdatePurchasability> Purchasability is set to true by default for all service type, unless it is explicitly set to false. Modifier will reuse it’s item’s purchasability. [optional]
name String Only required when updating modifiers. The record's name. Used as identifier to locate the correct record.
isFree Boolean Allows the modifier's price to be explicitly set as zero. Possible values are as follows: * `isFree` && `price == 0` sets the modifier's price to zero. * `isFree` && `price > 0` returns an error message that &quot;price cannot be set to > 0, if modifier is free”. * `!isFree` && `price > 0` sets the modifier's price to the defined price. * `!isFree` && `price == 0` does not update the modifier's price and reuses the existing price. [optional]

Enum: FieldEnum

Name Value
MODIFIER "MODIFIER"
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"

Enum: AvailableStatusEnum

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