Items management introduction

This section will detail all the functionalities that are available in terms of manipulating the item's modifications. A modification is a specific change that can be applied to an item using a set of specific options defined for the modification.

Notes#

warning
  • Modifications cannot be interacted with directly by clients. Instead, modifications are assigned to one or more items and can be selected by them through those items.
  • As mentioned above, modifications can be used by more than one item. As such, a judgement call must be made when it is appropriate to use the same modification or a different one. The following factors need to be considered.
    • Shared status
      • For example, if a restaurant has multiple burger items and cheese on top is a potential modification, it makes sense to use the same modification for all burgers in case the restaurant has run out of cheese and wants to disable this option globally for all items.
    • Shared options
      • For example, if a restaurant has multiple burger items and doneness is a potential modification, it makes sense to share this modification across all burgers since the options are relevant to all of them. Though, some individual items might have different default which in that case a shared modification would not work.
  • Since modifications are created together with their options and must be assigned to an item, they are, by default, not visible to clients. But, in case the modification need to be assigned to multiple items before being visible, they will be created in an unpublished state.