π¬ Branch Availability
π§Ύ Description
This document describes the branch_availability
event that Blend sends to delivery platforms
to pause or activate a branch. It is used to control whether a branch appears as open or closed
on the delivery app.
π Trigger
This event is triggered manually by the user from the Blend Operations Management Dashboard (OM Panel).
π§ How to Pause or Activate a Branch (UI Flow)
π Step 1: Login
Go to: https://om-staging.tryblend.net/
Login using the credentials provided to you by Blend.
π§ Step 2: Go to the Integration Page
Once logged in, navigate to the Integration page from the sidebar.
π Step 3: Pause or Resume Your Branch
- Each block will represent a branch
- You will see a Pause or Start button next to each branch
- Click Pause to make the branch temporarily unavailable
- Click Start to re-enable the branch
π Step 4: Blend Fires the Event
Blend will automatically send a branch_availability
event to the delivery appβs webhook
to reflect the change in branch visibility.
π§© JSON Payload
{
"event": "branch_availability",
"event_time": "2025-01-01 00:00:00",
"branch_id": "14589",
"payload": {
"branch_id": "1",
"is_available": false
}
}
π Field Descriptions
Field | Description |
---|---|
event | Always "branch_availability" β type of event |
event_time | Timestamp when the branch was paused/started |
branch_id | The branch initiating the event (usually same as payload) |
payload.branch_id | ID of the branch to pause/start |
payload.is_available | Boolean: true to make the branch live, false to pause it |
π§ Behavior
- If
is_available = false
β Blend will pause the branch on the delivery platform - If
is_available = true
β Blend will reactivate the branch and make it available for orders
β
Notes
- This event only controls branch visibility β it does not affect the menu or inventory
- Delivery apps may show the branch as "closed" or "offline" when paused
- This is a real-time control for operational status
Updated 24 days ago