createAdvertisement
ChatGPTRequires the advertisements add permission in the restaurant (like the admin UI), or the superadmin role. Creates an advertisement with an optional picture. restaurantId and name are required; the picture is imageBase64 (the raw Base64-encoded bytes of a PNG, JPEG or GIF picture, optionally as a data URI; a file path, file id or URL is not accepted; a picture which is too large is scaled down and converted to JPEG automatically). Pictures are never fetched from public URLs, file ids or file paths: the picture is always uploaded in the call as imageBase64. The public url in the results is only where the stored picture is published, never an input. The advertisements named exactly banner (the banner image at the top of the webshop page), banner_phone and banner_tablet (the banner for phones and tablets), footer (the footer image), background and logo feed the webshop: an advertisement with one of these names which is active and has an image is published at .../eatwithme.server/tableService/{restaurantId}/getImageByName/{name} (the url of the result), so the CSS can use it, e.g. body[theme="basic"] #generic-information { background-image: url(https://instance.eatwithme.online/instance11/eatwithme.server/tableService/1/getImageByName/footer); background-size: cover; }. A name can be used by one active advertisement only. Check getAdvertisements first: when an advertisement with the name exists, change it with updateAdvertisement instead. Call it with dryRun true first, show the returned changes to the user, tell the user that an active webshop advertisement goes live for the customers, and ask for confirmation before saving.
createIncomingStockDelivery
ChatGPTRequires the stockmanagement incoming stocks add permission in the restaurant (like the admin UI), or the superadmin role. Records an incoming stock (goods received from a supplier, with the invoice / delivery note numbers, the prices and the VAT). When it is not a draft, the stock of the items is increased from the date of the delivery, which is recalculated by the server as in the admin UI (stockRecalculation done, running or failed). So: 1) find the supplier, VAT categories and store with getIncomingStockDeliveries (suppliers, vatCategories, stores) and the items with searchMenuItems; 2) ask the user what was received (state the unitSize of each item, i.e. what one unit is), the prices (net or gross, per unit or in total) and the VAT category; 3) call createIncomingStockDelivery with dryRun true, read the supplier, date, invoice, entries (count, unitSize, prices, VAT) and totals back to the user and ask for confirmation, and whether to save it as a draft (the default, the stock does not change) or final; 4) save with dryRun false, once. Only items counted in the stock (inventory items) which are active can be received. restaurantId is the global restaurant id from getAuthorizedRestaurants; the other ids are the restaurant's own ids.
createInventory
ChatGPTRequires the stockmanagement inventories add permission in the restaurant (like the admin UI; a template also needs its view permission), or the superadmin role. Creates a stock inventory from the counts given by the user. Workflow: 1) getInventories with template true to find the template, then getInventories with its inventoryId to get its entries (skippedEntries are not countable, tell the user); 2) walk the user through the entries in the order of the template, a few at a time (for example by category), saying for each the name and the unitSize (what one unit is) and asking for the count; accept a number of units or an amount with unit (250 g); 3) when the user has answered, call createInventory with dryRun true and the entries (and templateId), read back the entries, uncounted items and the store, date and draft to the user and ask for confirmation, and ask whether it should be saved as a draft (default, no stock change) or final; 4) save with dryRun false. Call it only once for one counting. Items not counted are not stored, so their stock does not change; ask the user whether those are really zero or were skipped. Only items counted in the stock (inventory items) can be counted; recipe based products and the templates inherited from a master restaurant are not supported. A final inventory (draft false) recalculates the stock as the admin UI does (stockRecalculation done, running or failed); a draft has no effect on the stock until it is finalized in the admin UI. restaurantId is the global restaurant id from getAuthorizedRestaurants; storeId, templateId and menuItemId are the restaurant's own ids returned by getInventories and searchMenuItems.
createInventoryScrapping
ChatGPTRequires the stockmanagement inventory scrapping add permission in the restaurant (like the admin UI), or the superadmin role. Records an inventory scrapping (disposal) of wasted, spoiled, broken or otherwise written off stock: the stock of the items is reduced from the date of the scrapping, which is recalculated by the server as in the admin UI (stockRecalculation done, running or failed). It changes the stock and cannot be undone with this tool, so: 1) find the items with searchMenuItems and the store with getInventoryScrappings (stores); 2) ask the user what was scrapped, how much (state the unitSize of each item, i.e. what one unit is) and the reason; 3) call createInventoryScrapping with dryRun true, read the store, date and entries (count, unitSize, comment) back to the user and ask for confirmation; 4) save with dryRun false, once. Only active items can be scrapped: ingredients (items counted in the stock) and products (recipe based items such as a pizza or a drink, e.g. a wrongly made order). For a product give the number of portions as count (e.g. 2 pizzas = count 2); the server computes the ingredients from the recipe and deducts them from the stock, so never scrap the ingredients separately. A product with several portion sizes needs the quantity (the error lists them). restaurantId is the global restaurant id from getAuthorizedRestaurants; storeId and menuItemId are the restaurant's own ids returned by getInventoryScrappings and searchMenuItems.
createMauticContact
ChatGPTCreates a Mautic contact; fields.email is required and an existing email is refused. Call it with dryRun true, show the values and ask the user for confirmation first. Only a user with the superadmin role can use it, signed in with OAuth. It does not need a restaurant; restaurantId is only needed when several Mautic accounts are configured. Identify a contact with contactId or email.
createQuantityType
ChatGPTRequires the administration or administration servings add permission in the restaurant (like the admin UI), or the superadmin role. Creates a quantity type, the unit of the portions of the restaurant (dl, pcs, portion, ...; the servings page of the admin UI). restaurantId and name or names are required. The returned id is the quantityTypeId to give to the availableQuantities entries of createMenuItem and updateMenuItem; getRestaurantSettings lists the existing quantity types. Call it with dryRun true first and show the changes to the user before saving. The change is not pushed to POS devices or third-party channels (Wolt, Foodora) immediately.
deleteAdvertisement
ChatGPTRequires the advertisements delete permission in the restaurant (like the admin UI), or the superadmin role. Deletes an advertisement; it is not shown or served any more (a deleted banner or footer disappears from the webshop). To hide it temporarily use updateAdvertisement with isActive false. Call it with dryRun true first and ask the user to confirm before deleting.
deleteIncomingStockDelivery
ChatGPTRequires the stockmanagement incoming stocks delete permission in the restaurant (like the admin UI), or the superadmin role. Deletes an incoming stock with all its entries. When it was not a draft, its stock is taken back: the stock is recalculated by the server as in the admin UI (stockRecalculation done, running or failed). It cannot be undone, so: 1) find the delivery with getIncomingStockDeliveries; 2) call deleteIncomingStockDelivery with dryRun true, read the supplier, date, invoice and entries back to the user and ask for explicit confirmation; 3) call it again with dryRun false, once. restaurantId is the global restaurant id from getAuthorizedRestaurants.
deleteQuantityType
ChatGPTRequires the administration or administration servings delete permission in the restaurant (like the admin UI), or the superadmin role. Permanently deletes a quantity type (it cannot be restored). A quantity type which is still used by the quantities of any menu item cannot be deleted; the error tells how many entries use it, and those quantities have to be given another quantityTypeId with updateMenuItem first. Call it with dryRun true first and ask the user to confirm before deleting. The change is not pushed to POS devices or third-party channels (Wolt, Foodora) immediately.
finalizeInventory
ChatGPTRequires the stockmanagement inventories modify permission in the restaurant (like the admin UI), or the superadmin role. Finalizes an existing draft inventory (a stock count saved with draft true, for example by createInventory): it is not a draft any more and the stock is recalculated from the date of the inventory for every counted item, as the admin UI does when it saves the inventory (stockRecalculation done, running or failed). This changes the stock and cannot be undone with this tool, so: 1) find the inventory with getInventories (the draft flag) and read its entries with inventoryId; 2) call finalizeInventory with dryRun true, read the date, the store and the entries (count, unitSize) back to the user and ask for confirmation; 3) call it again with dryRun false, once. A template, an inventory which is already final and an inventory with recipe based products are rejected (finalize those in the admin UI, Stock management, Inventories). restaurantId is the global restaurant id from getAuthorizedRestaurants; inventoryId is the restaurant's own id returned by getInventories.
getAdvertisements
ChatGPTRead only. Lists the advertisements (administration > advertisements) of a restaurant with their preview pictures, and the status of the webshop images (webshopImages: published, missing, not active, no image or duplicate). Requires the advertisements view permission in the restaurant, or the superadmin role. Every advertisement has id, name, isActive, priority, the validity (fromDate, toDate, fromTime, toTime in minutes, days; empty means always), the menu item and category ids it applies to, hasImage, the picture details and the public url. The advertisements named exactly banner (the banner image at the top of the webshop page), banner_phone and banner_tablet (the banner for phones and tablets), footer (the footer image), background and logo feed the webshop: an advertisement with one of these names which is active and has an image is published at .../eatwithme.server/tableService/{restaurantId}/getImageByName/{name} (the url of the result), so the CSS can use it, e.g. body[theme="basic"] #generic-information { background-image: url(https://instance.eatwithme.online/instance11/eatwithme.server/tableService/1/getImageByName/footer); background-size: cover; }. A name can be used by one active advertisement only. Advertisements named ads_... are shown by the POS and waiter apps. restaurantId is the global restaurant id from getAuthorizedRestaurants.
getAuthorizedRestaurants
ChatGPTReturn the restaurants this client is authorized to query.
getConsumptionStockEntries
ChatGPTReturn raw consumption-stock entries for an authorized restaurant within a date range. Use the actual tenant table consumptionstockentry data for order-level stock consumption analysis.
getIncomingStockDeliveries
ChatGPTRead only. Lists the incoming stocks (goods received from a supplier: invoices and delivery notes, the Incoming stocks of the admin UI) of a restaurant, the newest first, or returns one with all its entries (deliveryId). Requires the stockmanagement incoming stocks view permission in the restaurant, or the superadmin role; users restricted to stores see only their stores. Every delivery has id, date, draft (a draft does not change the stock), supplier, invoiceId, deliveryNoteId, netTotal, bruttoTotal, createdBy, entryCount and, with entries, entries (entryId, menuItemId, name, unitSize = what one received unit is, e.g. 1 kg, count = the number of units, total, store, vatCategory, netUnitPrice, bruttoUnitPrice, netPrice, bruttoPrice, expiryDate, code; unmatched true for an invoice line not yet matched to a menu item). The list result also has suppliers, vatCategories and stores to choose from when creating a delivery, and total, offset, limit for paging. This is different from getIncomingStocks, which is the report of the received entries. restaurantId is the global restaurant id from getAuthorizedRestaurants; all other ids are the restaurant's own ids, as used by the menu tools.
getIncomingStocks
ChatGPTReturn incoming stock rows for an authorized restaurant within a date range for inventory and procurement analysis.
getInventories
ChatGPTRead only. Lists the stock inventories (stock counts) of a restaurant, the newest first, or its inventory templates (template true), or returns one with all its entries (inventoryId). Requires the stockmanagement inventories view permission in the restaurant (templates: inventories or inventory templates view), or the superadmin role; users restricted to stores see only their stores. Every inventory has id, date, draft (a draft does not change the stock yet), store, createdBy, created, modifiedBy, entryCount and, with entries, entries (menuItemId, name, category, unitSize = what one counted unit is, e.g. 1 kg or 0.7 l, count = the number of units counted, total = unitSize times count, expiryDate; originalCount with the stock view permission). A template has templateName and the entries to ask for when counting; template items which cannot be counted any more are in skippedEntries with the reason. The list result also has stores (id, name) and total, offset, limit for paging. restaurantId is the global restaurant id from getAuthorizedRestaurants; all other ids are the restaurant's own ids, as used by the menu tools.
getInventoryScrappings
ChatGPTRead only. Lists the inventory scrappings (disposals: wasted, spoiled, broken or otherwise written off stock) of a restaurant, the newest first, or returns one with all its entries (scrappingId). Requires the stockmanagement inventory scrapping view permission in the restaurant, or the superadmin role; users restricted to stores see only their stores. Every scrapping has id, date, store, createdBy, created, modifiedBy, entryCount and, with entries, entries (menuItemId, name, category, unitSize = what one scrapped unit is, e.g. 1 kg or 0.7 l, count = the number of units scrapped, total = unitSize times count, expiryDate, comment = the reason). The list result also has stores (id, name) and total, offset, limit for paging. restaurantId is the global restaurant id from getAuthorizedRestaurants; all other ids are the restaurant's own ids, as used by the menu tools.
getMauticContacts
ChatGPTRead only: searches the Mautic contacts (marketing / newsletter contacts) or reads one, with name, email, tags and the do-not-contact state per channel (doNotContact, e.g. email: true means the contact does not receive emails). Only a user with the superadmin role can use it, signed in with OAuth. It does not need a restaurant; restaurantId is only needed when several Mautic accounts are configured. Identify a contact with contactId or email.
getRestaurantCss
ChatGPTRead only. Returns the complete CSS of the restaurant (the css property of the restaurant, applied to the webshop and the apps) with its length, and the status (webshopImages) of the advertisements which feed the webshop images. Only a user with the superadmin role can use it for now. Use it first when the user wants to discuss or change the look of the webshop: show or summarize the current CSS, then change it with setRestaurantCss. The CSS typically imports a font, defines :root variables (colors, fonts) and styles body[theme="basic"] elements, with media queries for small screens. The advertisements named exactly banner (the banner image at the top of the webshop page), banner_phone and banner_tablet (the banner for phones and tablets), footer (the footer image), background and logo feed the webshop: an advertisement with one of these names which is active and has an image is published at .../eatwithme.server/tableService/{restaurantId}/getImageByName/{name} (the url of the result), so the CSS can use it, e.g. body[theme="basic"] #generic-information { background-image: url(https://instance.eatwithme.online/instance11/eatwithme.server/tableService/1/getImageByName/footer); background-size: cover; }. A name can be used by one active advertisement only. restaurantId is the global restaurant id from getAuthorizedRestaurants.
getRestaurantSettings
ChatGPTUse this to learn how a restaurant is configured and which options exist before creating or changing menu items and categories. Returns the restaurant profile (name, address, languages, default language, base currency, currencies, payment methods) and the option lists with their ids: vatCategories (for vatCategoryId), quantityTypes (for quantityTypeId), timings (the courses and whether each is enabled), productionLines (for productionLineIds) and labels, plus the restaurant settings tree (business day, service fee, enabled features such as takeaway, pickup, kiosk, webshop, Wolt, Foodora, menu and price calculation options, ...). The tree shows which settings exist and their current values. Use path (for example enabled-features/wolt) to read only one part of the tree, or includeSettings false to get only the option lists. Secrets such as keys, tokens and passwords are hidden. restaurantId is the global restaurant id from getAuthorizedRestaurants; all other ids in the result are the restaurant's own ids, as used by the menu tools.
getRestaurantStatus
ChatGPTReturn the current active and connected status for a specific authorized restaurant. Does not expose service URLs or hostnames.
getSales
ChatGPTReturn sales rows for an authorized restaurant within a date range for sales and revenue analysis. Do not use this tool to identify customers or guests, retrieve contact details, or infer identities from transactions; guest contact details are not available. Returned staff attribution identifies staff only.
getStockHtml
ChatGPTReturn stock shopping-list data for an authorized restaurant: items below desired level and recent supplier suggestions for purchasing.
getStockStatistics
ChatGPTReturn stock statistics for an authorized restaurant within a date range using the same aggregation logic as the stock statistics report.
recommendVideoTutorials
ChatGPTRead only knowledge base lookup: advises the YouTube video tutorials of EatWithMe to watch for what the user wants to learn or do, e.g. 'Is there a video about printers?' or 'How do I do the inventory?'. Pass the question of the user as query; it returns the best matching videos with their title, summary and url. Give the url to the user as a link and say in a sentence why the video fits; when videoLanguages is given and does not include the language of the user, tell in which language the video is. Recommend only the videos returned; when none matches, say there is no video about it yet. It does not need a restaurant.
searchKnowledgeBase
ChatGPTRead only knowledge base lookup: searches the EatWithMe guidelines and what's new articles, the documentation of the features, e.g. 'How do I use inventory templates?', 'What is new in stock management?' or 'How do I set the restaurant theme?'. It is downloaded fresh from the console, so it is always the current documentation. Pass the question of the user as query; it returns the best matching articles with their text (content), tags and video links. Answer only from the returned articles and name the article; when none matches, say the documentation does not cover it. For a video to watch use recommendVideoTutorials. It does not need a restaurant.
setMauticDoNotContact
ChatGPTSets (doNotContact true) or clears (false) the do-not-contact setting of a Mautic contact for a channel, then reads it back (verified). For email it also updates the customer of this server with the same Mautic id (customerUpdated), because the Mautic sync would otherwise restore the old value. Clearing a contact that unsubscribed or bounced by itself (before.reason) needs the explicit confirmation of the user. Call it with dryRun true, show the before state and ask the user for confirmation first. Only a user with the superadmin role can use it, signed in with OAuth. It does not need a restaurant; restaurantId is only needed when several Mautic accounts are configured. Identify a contact with contactId or email.
setRestaurantCss
ChatGPTOnly a user with the superadmin role can use it for now. PUBLISHES the CSS of the restaurant to its live, public webshop and apps: it replaces the css property of the restaurant, and customers see the new look after a page refresh. restaurantId and css (the COMPLETE new stylesheet, not a patch) are required: read the current CSS with getRestaurantCss, change it as discussed with the user and send the whole result. Call it with dryRun true first, tell the user what will change and that it goes live for the customers of the restaurant, and ask for confirmation before saving. The images of the page (banner, footer) are managed with the advertisement tools: The advertisements named exactly banner (the banner image at the top of the webshop page), banner_phone and banner_tablet (the banner for phones and tablets), footer (the footer image), background and logo feed the webshop: an advertisement with one of these names which is active and has an image is published at .../eatwithme.server/tableService/{restaurantId}/getImageByName/{name} (the url of the result), so the CSS can use it, e.g. body[theme="basic"] #generic-information { background-image: url(https://instance.eatwithme.online/instance11/eatwithme.server/tableService/1/getImageByName/footer); background-size: cover; }. A name can be used by one active advertisement only.
updateAdvertisement
ChatGPTRequires the advertisements modify permission in the restaurant (like the admin UI), or the superadmin role. Changes the name, the active state, the priority or the picture of an advertisement (imageBase64, the Base64-encoded bytes of the new picture, replaces the picture, removeImage deletes it); the other fields (validity, menu items) are not changed. restaurantId and advertisementId are required. Use it to replace the banner or footer picture of the webshop, or to hide it with isActive false. Pictures are never fetched from public URLs, file ids or file paths: the picture is always uploaded in the call as imageBase64. The public url in the results is only where the stored picture is published, never an input. The advertisements named exactly banner (the banner image at the top of the webshop page), banner_phone and banner_tablet (the banner for phones and tablets), footer (the footer image), background and logo feed the webshop: an advertisement with one of these names which is active and has an image is published at .../eatwithme.server/tableService/{restaurantId}/getImageByName/{name} (the url of the result), so the CSS can use it, e.g. body[theme="basic"] #generic-information { background-image: url(https://instance.eatwithme.online/instance11/eatwithme.server/tableService/1/getImageByName/footer); background-size: cover; }. A name can be used by one active advertisement only. Call it with dryRun true first, show the returned changes to the user, tell the user that the change goes live in the webshop for the customers, and ask for confirmation before saving; check the result with getAdvertisements.
updateIncomingStockDelivery
ChatGPTRequires the stockmanagement incoming stocks modify permission in the restaurant (like the admin UI), or the superadmin role. Changes an existing incoming stock: its supplier, date, invoice / delivery note numbers, draft flag (draft false finalizes it) and its entries. When the delivery is or was not a draft, the stock is recalculated by the server as in the admin UI (stockRecalculation done, running or failed). It changes the stock and cannot be undone with this tool, so: 1) read the delivery with getIncomingStockDeliveries (deliveryId); 2) ask the user what to change; 3) call updateIncomingStockDelivery with dryRun true, read the result (supplier, date, entries, totals) back to the user and ask for confirmation, especially when entries are removed; 4) call it again with dryRun false, once. To change entries send the complete list (see entries). A delivery with invoice lines not yet matched to a menu item (unmatched) can have its entries changed only in the admin UI. restaurantId is the global restaurant id from getAuthorizedRestaurants.
updateMauticContact
ChatGPTChanges fields and tags of a Mautic contact (it cannot delete a contact and does not change the do-not-contact state: use setMauticDoNotContact). Call it with dryRun true, show the changes and ask the user for confirmation first. Only a user with the superadmin role can use it, signed in with OAuth. It does not need a restaurant; restaurantId is only needed when several Mautic accounts are configured. Identify a contact with contactId or email.
updateQuantityType
ChatGPTRequires the administration or administration servings modify permission in the restaurant (like the admin UI), or the superadmin role. Renames a quantity type (the unit of the portions). restaurantId, quantityTypeId and name or names are required. All the menu items which use the quantity type show the new name (usedByQuantities in the result tells how many quantity entries use it). Call it with dryRun true first and show the returned changes to the user before saving. The change is not pushed to POS devices or third-party channels (Wolt, Foodora) immediately.