Skip to content

IPD-18111: Added document for ARI #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@
* [CRM Endpoint](notifications/crm-endpoint.md)
* [Invoice Endpoint](notifications/payments-endpoint.md)
* [Booking Endpoint](notifications/venues-endpoint.md)
* [ARI Endpoint](notifications/ari-endpoint.md)
* [Event Endpoint](notifications/events-endpoint.md)
* [Development Reference](development-reference/README.md)
* [Calculating md5](development-reference/calculating-md5.md)
Expand Down
122 changes: 122 additions & 0 deletions notifications/ari-endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# ARI Notifications (Availability, Rates, Inventory)

iVvy publishes ARI (Availability, Rates, Inventory) notifications to help external systems stay in sync with changes in room availability, rates, and booking rules.

---

## `RoomInventoryUpdated`

### **Message**
`RoomInventoryUpdated`

### **Body**
```json
{
"data": [
{
"date": "2025-12-16",
"roomId": 7,
"inventoryCount": 3,
"availableCount": 3
},
{
"date": "2025-12-16",
"roomId": 2,
"inventoryCount": 130,
"availableCount": 130
}
]
}
```

### **Description**
This notification is published when:
- The room's dynamic inventory is updated via API.*
- The available count for a room changes.
- Blocked room count is updated for bookings with status Tentative, Confirmed, or Prospective Hold.
- Booking status changes between reserved and non-reserved.
- Booking is moved to different dates.
- Booking or accommodation block is deleted.

> *Note: * Only applies to venues with a distribution channel.*

---

## `RoomRatesUpdated`

### **Message**
`RoomRatesUpdated`

### **Body**
```json
{
"data": [
{
"barId": 63,
"roomId": 122,
"date": "2025-07-06",
"cost": null,
"costDouble": null,
"costTriple": null,
"costQuad": null
},
{
"barId": 63,
"roomId": 123,
"date": "2025-07-06",
"cost": 50,
"costDouble": 60,
"costTriple": 0,
"costQuad": 80
}
]
}
```

### **Description**
This notification is published when:
- Dynamic room rates are updated via API.*
- Rate plan values are modified for any future or existing dates.

> *Note: * Only applies to venues with a distribution channel.*

> *Rate plan deletions are not handled.*

---

## `RatePlanBookingRulesUpdated`

### **Message**
`RatePlanBookingRulesUpdated`

### **Body**
```json
{
"data": [
{
"barId": 1,
"roomId": 6,
"date": "2026-05-09",
"closeOutStatus": 2
},
{
"barId": 1,
"roomId": 6,
"date": "2026-05-10",
"closeOutStatus": 2
},
{
"barId": 1,
"roomId": 6,
"date": "2026-05-11",
"closeOutStatus": null
}
]
}
```

### **Description**
This notification is published when:
- Booking rules for a rate plan are updated via API.

---
1 change: 1 addition & 0 deletions notifications/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,4 +191,5 @@ Here is the list of endpoints
| crmEndpoint | [Click Here](crm-endpoint.md) |
| paymentsEndpoint | [Click Here](payments-endpoint.md) |
| venuesEndpoint | [Click Here](venues-endpoint.md) |
| ariEndpoint | [Click Here](ari-endpoint.md) |
| eventsEndpoint | [Click Here](events-endpoint.md) |