Skip to main content

Room

Overview

The room module synchronizes room master data for a company. This module depends on both company and room_type. The referenced company_id and room_type_id must already exist for that company, so the corresponding company must be synchronized first, followed by its room types.

Request

  • Method: POST
  • Path: {{base_url}}/api/sync-master-data

Request Envelope

The Room module uses the standard Open API request envelope with room as the module and an array of room objects as data.

{
"module": "room",
"data": [
{}
],
"chunk_metadata": {}
}

Request Body Fields

FieldTypeRequiredDescriptionExample
idstringYesRoom identifier.RM-101
company_idstringYesIdentifier of the company the room belongs to.HTL-001
room_type_idstringYesMust match an id already sent via room_type for this company.RT-01
namestringYesRoom name or number.101
room_statusstringYesRoom status.AVAILABLE
is_virtual_roombooleanYesIndicates whether the room is a virtual room.false

Request Example

{
"module": "room",
"data": [
{
"id": "RM-101",
"company_id": "HTL-001",
"room_type_id": "RT-01",
"name": "101",
"room_status": "AVAILABLE",
"is_virtual_room": false
}
],
"chunk_metadata": {
"process_id": "sync-htl001-2026-08-30",
"chunk_sequence": 1,
"is_last_chunk": true,
"total_records_in_chunk": 1
}
}