Message Description
The inventory count notification is used to send base inventory levels by inventory code, (e.g. room type code) to establish the physical inventory count. Physical inventory is the basis by which availability is determined; however, additional calculations may also figure into assigning the inventory counts for availability. The inventory count notification message can be used to communicate to Revenue Management Systems how many rooms are available to sell during a specific period. A reservation system may choose not to synchronize with actual inventory numbers, rather with a threshold. Properties and booking sources need to agree on common thresholds, whether they are derived from virtual or real inventory, in addition to a way to accommodate overbooking.
The inventory count notification supports both base and off-sell inventory. The base inventory message accommodates changes in the base inventory levels, such as adding a new wing to a hotel. The off-sell inventory message sends a count of the inventory that is not available for sale. The off-sell messages indicate whether that inventory is temporarily out of order or has been taken off the market, as well as whether the inventory count is an adjustment to a current off-sell value, or a replacement of a previously determined amount.
Sequence
The inventory publisher constructs a message containing availability changes and transmits the message payload.
The inventory subscriber processes the message and updates room type inventory based on the message payload.
The subscriber responds with an appropriate response message which may include warnings from business processing rules or errors if the request fails. All message responses include the request identification. Responses may be returned in any order.
Both PMS System will push a delta message for each modification in the PMS. An overlay message is not automatically pushed by the PMS, this overlay message is only pushed by request.
Message Attributes
OTA_HotelInvCountNotifRQ
| Element | @Attribute | Type | Num | Description | Comments + Contents outbound | pAir | OnPrem |
|---|---|---|---|---|---|---|
OTA_HotelInvCountNotifRQ | 1 | Root element of the message. |
|
| ||
@EchoToken | StringLength1to128 | 0..1 | A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. |
|
| |
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. |
|
| |
@TimeStamp | dateTime | 1 | Timestamp of the transaction. |
|
| |
@Version | decimal | 0..1 | Version of the message | 2.000 |
|
|
@PrimaryLangID | language | 0..1 | Default language of the property. | "en" |
|
|
OTA_HotelInvCountNotifRQ | POS | 1 | POS provides a mechanism to indicate the source of a message. |
|
| ||
OTA_HotelInvCountNotifRQ | POS | Source | 1..10 | This holds details regarding the requester. It may be repeated to also accommodate the delivery systems. |
|
| ||
OTA_HotelInvCountNotifRQ | POS | Source | RequestorID | 0..1 | The system sending the request message. An identifier of the entity making the request (e.g. ATA/IATA/ID number, Electronic Reservation Service Provider (ERSP), Association of British Travel Agents (ABTA)). |
|
| ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) |
|
| |
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. |
|
| |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" |
|
|
OTA_HotelInvCountNotifRQ | POS | Source | BookingChannel | 0..1 | This element is used to pass the booking source for the reservation. To send secondary booking channel information an additional Source element needs to be sent. |
|
| ||
@Type | OTA_CodeType BCT | 1 | Indicates the type of booking channel per Open Travel BCT codes. |
|
| |
@Primary | boolean | 0..1 | Primary attribute would be set to “true” if only one booking channel is transferred. Only one source should be marked “true” if multiple sources are sent. | "true" |
|
|
OTA_HotelInvCountNotifRQ | POS | Source | TPA_Extensions | 0..1 | Allows extensions to be added to the OpenTravel specification per trading partner agreement. |
|  | ||
OTA_HotelInvCountNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | 1 | Used to transport extensions on POS level for the system which initiated the transaction. | | | ||
OTA_HotelInvCountNotifRQ | POS | Source | TPA_Extensions | px:POSExtensions | px:HotelInfo | 0..1 | Used to transport extensions on POS level for the property which holds the reservation. |
| | ||
@FiscalDate | date | 1 | This attribute transfers the actual date of the PMS system. |
|
| |
OTA_HotelInvCountNotifRQ | UniqueID | 1 | The unique ID depends on the system generating the booking; i.e., if the booking is generated by the PMS this field would contain the PMS confirmation number; if the system is a CRS, the CRS confirmation number. | |
| ||
@ID | StringLength1to32 | 1 | The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages. |
|
| |
@ID_Context | StringLength1to32 | 1 | Used to identify where the ID comes from. | "protelIO" |
|
|
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) |
|
| |
OTA_HotelInvCountNotifRQ | Inventories | 1 | A collection of Inventory. Hotel identification information are the attributes of this element. |
|
| ||
@ChainCode | StringLength1to8 | 0..1 | Chain name indicates the chain to which the property belongs. |
|
| |
@HotelCode | StringLength1to16 | 0..1 | This is the Hotel Cloud ID for which the reservations are being transferred. |
|
| |
@HotelName | StringLength1to128 | 0..1 | Full name of the property which the transferred reservation belongs to. |
|
| |
OTA_HotelInvCountNotifRQ | Inventories | Inventory | 1..n | This is the inventory information for a given rate plan, room type, date, etc. |
|
| ||
OTA_HotelInvCountNotifRQ | Inventories | Inventory | StatusApplicationControl | 0..1 | Information on what the InvCountNotif Message applies to (i.e. the combination of inventory and/or rate codes) and the period of application. |
|
| ||
@Start | date | 1 | The first date for which the availability update is being sent. |
|
| |
| @End | date | 1 | The last date for which the availability update is being sent. |
|
| |
@AllInvCode | boolean | 0..1 | When true indicates that the data transmitted is for total inventory in the hotel. This field is required if @InvTypeCode is not sent. The content of this attribute determines which @CountTypes will be sent. | @AllInvCode="false" or missing by default refers to room level data @AllInvCode="true" refers to hotel level data |
|
|
@InvCode | StringLength1to16 | 0..1 | Code that identifies an inventory item. |
|
| |
@InvTypeCode | StringLength1to16 | 0..1 | This is the room type code for which the update is being sent. This field is required if @AllInvCode="false" or missing. This field should not be sent if @AllInvCode="true". | "SKG" |
|
|
@IsRoom | boolean | 0..1 | Simple indicator to detect if inventory is a room. |
|
| |
OTA_HotelInvCountNotifRQ | Inventories | Inventory | InvCounts | 0..1 | A collection of inventory counts. |
|
| ||
OTA_HotelInvCountNotifRQ | Inventories | Inventory | InvCounts | InvCount | 1..n | Individual inventory count (e.g.; Physical, Available, Sold, OOO, NAFS). |
|
| ||
@CountType | OTA_CodeType INV | 0..1 | A numeric value referencing the type of inventory being counted. Refer to the OTA Code list: Inventory Count Type (INV) . Count types 1 to 6 are shown at both room and hotel level, whereas count types 16-18 are shown only for hotel level. Determined by the @AllInvCode attribute |
|
| |
@Count | integer | 0..1 | Number of rooms of this specific type. |
|
| |
OTA_HotelInvCountNotifRQ | Inventories | Inventory | UniqueID | 0..1 | The unique identifier element allows the trading partners to uniquely identify each InvCountNotifRQ, (i.e. the entire message) for transaction traceability. | | | ||
@Type | OTA_CodeType UIT | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT) |
|
| |
@ID | StringLength1to32 | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. |
|
| |
@ID_Context | StringLength1to32 | 1 | Used to identify the source of the identifier. | "protelIO" |
|
|
OTA_HotelInvCountNotifRS
| Element | @Attribute | Type | Num | Description | Comments + Contents inbound | pAIR | OnPrem |
|---|---|---|---|---|---|---|
OTA_HotelInvCountNotifRS | 1 | Root element of the message. | | | ||
@EchoToken | StringLength1to128 | 0..1 | A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value. | | | |
@CorrelationID | StringLength1to64 | 1 | Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory. | | | |
@TimeStamp | dateTime | 1 | Timestamp of the transaction. | | | |
@Version | decimal | 0..1 | Version of the message | | | |
@PrimaryLangID | language | 0..1 | Default language of the property. | "en" | | |
OTA_HotelInvCountNotifRS | Errors | 1 | Indicates an error occurred during the processing of the message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element instead. | | | ||
OTA_HotelInvCountNotifRS | Errors | Error | 1..99 | An error that occurred during the processing of a message. | | | ||
@Type | OTA_CodeType | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | | | |
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. | | | |
OTA_HotelInvCountNotifRS | Success | 1 | Returning an empty element of this type indicates the successful processing of the message. It could be combined with warning message/s if the message had issue/s. | | | ||
OTA_HotelInvCountNotifRS | Warnings | 1 | Used when a message has been successfully processed to report any warnings or business errors that occurred. | | | ||
OTA_HotelInvCountNotifRS | Warnings | Warning | 1..999 | Used in conjunction with the Success element to define a business error. | | | ||
@Type | OTA_CodeType | 1 | Mandatory. Refer to the OTA Code List: Error Warning Type (EWT). | | | |
@Code | OTA_CodeType | 0..1 | Refers to the OTA Code List: Error Codes (ERR). | | | |
@RecordID | StringLength1to64 | 0..1 | If the receiving system is able to identify within a batch of availability status messages which specific message failed, the UniqueID of the message should be reported here. | | | |
@ShortText | StringLength1to64 | 0..1 | Describes the occurring error in short. | | |