MenuSnapshot
The menu document exactly as Sous Chef last published it to one storefront's delivery platform: categories, items, modifiers, prices and hours as the platform received them.
Snapshots are returned exactly as recorded and never regenerated, so an older snapshot can lack a field a newer one carries, carry null where its source was empty, or carry a key not listed here. Ignore keys you do not recognise.
Fields
- idstring
Sous Chef menu id: the same value as the enclosing
MenuAssignment.menuId. - storeIdstring
The delivery platform's id for the storefront (its external store id), not the Sous Chef
storeIdthe enclosingStoreMenuAssignmentsis keyed by. - storeMenuIdstring
Sous Chef id of the menu-to-storefront assignment this was published for; absent on some older snapshots.
- namestring
The menu name as published.
- subtitlestring
The menu subtitle as published; may be empty or
null. - availableboolean
Whether the menu was switched on at publish time.
- useLocationHoursboolean
truewhen the menu follows its location's hours rather than its own;workingHoursis then the location's hours as they stood at publish time. On a storefront whose brand's organization does not own the kitchen and had set its own weekly hours there, it is those hours instead. - workingHoursMenuSnapshotWorkingHours[]
The weekly hours the menu was published with.
- specialHoursMenuSnapshotSpecialHours[]
The date-specific overrides the menu was published with.
- categoriesMenuSnapshotCategory[]
The menu's categories, in display order.
- deleteExistingMenusboolean
The publish instruction sent to the platform:
trueasked it to replace every existing menu on the storefront with this publish.