Modifier Availability

🧾 Description

This document describes the modifier_availability event that Blend sends to delivery platforms
to show or hide a specific modifier 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 modifier.

🧭 How to Change modifier Availability from Dashboard

Use the Blend dashboard to change modifier 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 Modifiers Tab

Select the menu you want to edit and click on the Modifiers tab.

✏️ Step 4: Edit Modifier

Find the modifier you want to update and click Edit.

📦 Step 5: Manage Availability

On the upper right of the modifier form, you will see a section called Availability.
Click the Edit icon inside that section.

Toggle the modifier availability using the switch
Click Save

🚀 Step 6: Blend Pushes Event

Blend will automatically fire the modifier_availability event to the delivery app’s webhook.

🧩 JSON Payload

{
  "event": "modifier_availability",
  "event_time": "2025-01-01 00:00:00",
  "branch_id": "14589",
  "payload": {
    "modifier_id": "1",
    "is_available": false
  }
}

🗂 Field Descriptions

Field	Description
`event`	Always `"modifier_availability"` — type of event
`event_time`	Timestamp of when the toggle action occurred
`branch_id`	The branch that owns the modifier
`payload.modifier_id`	The internal or shared ID of the modifier being updated
`payload.is_available`	Boolean: `true` to show the modifier, `false` to hide it

🧠 Behavior

If is_available = false → Blend will instruct the delivery app to hide this modifier.
If is_available = true → Blend will make the modifier visible again on the menu.
This does not delete or remove the modifier, only toggles its availability.

🔧 Example Use Cases

Branch runs out of shawarma → Merchant disables it
Branch re-stocks drinks → Admin enables the drink modifier
Scheduled product availability → automation triggers change

✅ Notes

This event does not update the full modifier object — only its visibility
If the delivery app does not support modifier-level toggling, this event may be ignored
This is a lightweight payload, perfect for real-time menu updates