β Item Availability
π§Ύ Description
This document describes the item_availability
event that Blend sends to delivery platforms
to show or hide a specific item on a merchant's menu.
This is useful when a product is temporarily out of stock or being brought back into availability.
π Trigger
This event is triggered when a merchant or admin updates the availability status of an item.
π§ How to Change Item Availability from Dashboard
Use the Blend dashboard to change item visibility with no API calls.
π Step 1: Login
Go to https://bm-staging.tryblend.net/
Login using your Blend credentials.
π Step 2: Open the Menu Page
From the sidebar, go to Menu
π Step 3: Enter the Items Tab
Select the menu you want to edit and click on the Items tab.
βοΈ Step 4: Edit Item
Find the item you want to update and click Edit.
π¦ Step 5: Manage Availability
On the upper right of the item form, you will see a section called Availability.
Click the Edit icon inside that section.
- Toggle the item availability using the switch
- Click Save
π Step 6: Blend Pushes Event
Blend will automatically fire the item_availability
event to the delivery appβs webhook.
π§© JSON Payload
{
"event": "item_availability",
"event_time": "2025-01-01 00:00:00",
"branch_id": "14589",
"payload": {
"item_id": "1",
"is_available": false
}
}
π Field Descriptions
Field | Description |
---|---|
event | Always "item_availability" β type of event |
event_time | Timestamp of when the toggle action occurred |
branch_id | The branch that owns the item |
payload.item_id | The internal or shared ID of the item being updated |
payload.is_available | Boolean: true to show the item, false to hide it |
π§ Behavior
- If
is_available = false
β Blend will instruct the delivery app to hide this item. - If
is_available = true
β Blend will make the item visible again on the menu. - This does not delete or remove the item, only toggles its availability.
π§ Example Use Cases
- Branch runs out of shawarma β Merchant disables it
- Branch re-stocks drinks β Admin enables the drink item
- Scheduled product availability β automation triggers change
β
Notes
- This event does not update the full item object β only its visibility
- If the delivery app does not support item-level toggling, this event may be ignored
- This is a lightweight payload, perfect for real-time menu updates
Updated 2 months ago