Skip to main content

ItemClass

Properties

NameTypeDescriptionNotes
idStringItem id that will be used for cart building on /cart route[default to null]
is_visible_on_off_dateBooleanIndicates item to not be shown to customers on an off-date[optional] [default to null]
extra_groupListList of grouped extras of an item[optional] [default to null]
item_limit_per_time_slotListMaximum number of allowed purchase of the item across all platform per time slot[optional] [default to null]
item_codeStringRandom unique item code[default to null]
is_bulkBooleanIndicates the item is bulky and will automatically select car on checkout if order type is delivery[optional] [default to null]
is_meal_planBooleanIndicates if item is part of meal plan order type[optional] [default to null]
off_datesListStore off dates helper[optional] [default to null]
item_limit_per_dayBigDecimalMaximum number of allowed purchase of the item across all platform per day[optional] [default to null]
store_idStringStore which this item belongs to, can be used for filtering[optional] [default to null]
store_nameStringStore name which this item belongs to[optional] [default to null]
nameStringThe name of the item[default to null]
descriptionStringThe description of the item[default to null]
image_urlStringThe nominated item display image in url form[default to null]
discount_descriptionStringThe item discount description[optional] [default to null]
active_discountStringThe peso value of the current active item discount. If discount_type is rawDiscount, this is equal to the discount_value. If percentDiscount, this is equal to the regular_price multiplied to the discount_value/100.[optional] [default to null]
priceStringThe active price of the item, if there is an active discount, this should be equal to the discounted_price, if there is no active discount, this should be equal to the regular price[default to null]
discount_typeStringThe type of discount applied ("noDiscount", "rawDiscount", "percentDiscount")[optional] [default to null]
discount_valueStringThe value of the discount applied. For example if discount_value is "20", if discount_type is percentDiscount, this means 20% off. If discount_type is rawDiscount, this means P20.00 off.[optional] [default to null]
discounted_priceStringThe peso value of the item, applying the active_discount to the regular_price.[default to null]
regular_priceStringThe peso value of the item without any discounts.[optional] [default to null]
tagsListItem tags[default to null]
availableBooleanItem is available for order[optional] [default to null]
categoryStringItem category, should be in store category list[optional] [default to null]
extrasBooleanIndicates if item has an extra group to be shown as part of the order[optional] [default to null]
visibleBooleanIndicates if item should be visible to the customer[optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]