<aside> 💡 This API has been superseded by Item Availability Version 2 and will be decommissioned by December 2022. You should only be using this API if you have already integrated your POS or 3PA with the Flyt Platform. If you are developing a new integration, please use Item Availability Version 2 instead.
</aside>
The Item Availability API allows you to manage which items on a menu are available for ordering via your delivery partner (Just Eat, Skip The Dishes, Menulog or Takeaway).
Menu items are marked as available or unavailable individually (i.e. one request per menu item), via requests to the Update Item Availability endpoint described below.
<aside> 💡 Important: Pushing a menu to your delivery partner using the Publishing Menus API will automatically set all items on the menu as available; thereby overwriting any previously unavailable statuses to available.
</aside>
POST <https://api.flypaythis.com/stock/{BRAND_ID}/locations/{LOCATION_ID}/stock-update>
X-Flyt-API-Key: the API key you received from Flyt. This API key is unique for item availability and cannot be used for menus. You should not share this API key with anyone outside your organisation.
Content-Type: specified the content type of your request. Should always be set to application/json.
BRAND_ID: a unique identifier for the brand for which this integration is being built. This name is used internally by the Flyt Platform to determine which business is making a request.
LOCATION_ID: a unique identifier for the restaurant the menu belongs to. Send us the internal ID you have for your restaurants. This location ID will be mapped directly to the corresponding delivery partner restaurant.
<aside> 💡 Except if otherwise noted, body attributes are mandatory.
</aside>
itemReference: the menu item's unique PLU as previously sent via a call to the Publishing Menus API.event: IN_STOCK to mark the menu item as available for ordering, OUT_OF_STOCK to mark the item as unavailable for ordering.happenedAt: timestamp indicating when the item became available or unavailable. Must be in ISO format, e.g. "2020-10-11T14:56:18.234284+01:00".