Skip to main content

Delete Rooms

Mutation Overview​

The deleteRoomsSetUp mutation is designed to remove rooms from hotel rates in Inventory. The returned fields include:

  • success
  • adviseMessages

1. Criteria​

When building your mutation, you need to provide the following input fields:

Mandatory Input​

  • clientCode
  • supplierCode
  • hotelCode
  • rateCode
  • roomCodes

Optional Input​

  • contextCode

2. Settings​

To delete a room, ensure that all mandatory fields are properly filled out and associate the room with the correct hotel and rate.

Response Considerations​

The mutation returns the deletion status along with success status and possible advise messages.

RoomsSetUpRs (OBJECT)​

  • success (Boolean) - Indicates if the operation was successful.
  • adviseMessages (AdviseMessage) - Messages related to the operation.

Mutation Inputs​

InventoryRoomSetupDeleteInput (INPUT_OBJECT)
Rooms setup delete input data

clientCode  *  (String)
Client code.

supplierCode  *  (String)
Travelgate Supplier/Channel code.

roomCodes  *  (String)
Rooms codes to delete.

rateCode  *  (String)
Rate Code .

hotelCode  *  (String)
Code associated with the hotel.

contextCode (String)
Context code.

Returned Fields​

RoomsSetUpRs (OBJECT)
Represents the response object for room setup operations.

adviseMessages (AdviseMessage)
Collection of advise messages.

code  *  (ID)
AM code: The following codes can be returned:

description  *  (String)
Error description

level  *  (Enum of AdviseMessageLevel)
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO

external (ExternalMessage)
Specify the external message.

code (String)
External code.

message  *  (String)
External message.

correlationID  *  (ID)
Identifier to investigate the cause of the error.

rateCode (String)
Rate code associated with the rooms.

rooms (InventoryRoomSetUp)
Collection of room setup responses.

code (String)
Code associated with the room.

master (InventoryMasterRoom)
Master of the room.

id  *  (Int)
Id associated with the room master.

code (String)
Code associated with the room.

name (String)
Name associated with the room.

active  *  (Boolean)
Indicates whether the room is active.

externalCode (String)
External code associated with the room.

standard  *  (Int)
Standard of the room. Typically the number of guests.

uses  *  (InventoryRoomUse)
List of uses associated with the room.

numberOfGuests  *  (Int)
Gets or sets the number of guests allowed in the room.

minAge  *  (Int)
Gets or sets the minimum age allowed for guests in the room.

maxAge  *  (Int)
Gets or sets the maximum age allowed for guests in the room.

paxType  *  (Enum of InventoryPaxType)
Gets or sets the type of guests allowed in the room. PaxType
Possible values:
INFANT
CHILD
ADULT

success  *  (Boolean)
Indicates whether the operation was successful based on the absence of advise messages.

Examples​

Delete a Room​