diff --git a/SUMMARY.md b/SUMMARY.md index 6e4f7d6..fb5013e 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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) diff --git a/notifications/ari-endpoint.md b/notifications/ari-endpoint.md new file mode 100644 index 0000000..cc933de --- /dev/null +++ b/notifications/ari-endpoint.md @@ -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. + +--- \ No newline at end of file diff --git a/notifications/notifications.md b/notifications/notifications.md index e2c913d..c081abc 100644 --- a/notifications/notifications.md +++ b/notifications/notifications.md @@ -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) |