OTA_HotelInvCountNotifRQ / OTA_HotelInvCountNotifRS

The OTA_HotelInvCountNotif messages are used to update the following elements in the Hotel-Spider system:

The amount of rooms available per room/date
The Open/Close restriction per room/date

Every time the hotel's inventory has been changed inside the third party software, the changes (and only the changes) should be transfered to Hotel-Spider. As this is a "notif" message, it implies that the third party software client pushes the information to the Hotel-Spider servers.

Endpoints

HTTP RAW XML POST
- Staging: https://staging-api.hotel-spider.com/ota/2014A/OTA_HotelInvCountNotifRQ
- Production: https://api.hotel-spider.com/ota/2014A/OTA_HotelInvCountNotifRQ
SOAP
- Staging: https://staging-api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014A/OTAService#OTA_HotelInvCountNotifRQ
- Production: https://api.hotel-spider.com/soap/ota
  - SoapAction: http://htng.org/2014A/OTAService#OTA_HotelInvCountNotifRQ
JSON (We recommend using OTA via XML, if you want to use JSON interface please contact us)

Example request and response

OTA_HotelInvCountNotifRQ request

<OTA_HotelInvCountNotifRQ PrimaryLangID="en" TimeStamp="2015-06-30T17:26:26+02:00" Target="Test" Version="1.000" xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelDescriptiveInfoRQ.xsd">
  <POS>
    <Source>
      <RequestorID ID="USERNAME" MessagePassword="PASSWORD"></RequestorID>
    </Source>
  </POS>
  <Inventories HotelCode="HOTELCODE" HotelName="HOTELNAME">
    <Inventory>
      <StatusApplicationControl InvCode="00F556c42e0d6559" Start="2015-06-30" End="2015-06-30" />
      <InvCounts>
        <InvCount Count="3" CountType="14" ActionType="Allocation" />
      </InvCounts>
    </Inventory>
    <Inventory>
      <StatusApplicationControl InvCode="00F556c42e0d6559" Start="2015-06-30" End="2015-06-30" />
      <OffSell OffSellValue="0" />
    </Inventory>
  </Inventories>
</OTA_HotelInvCountNotifRQ>

OTA_HotelInvCountNotifRS response

<OTA_HotelInvCountNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelBookingRuleNotifRQ.xsd" TimeStamp="2015-11-17T14:45:54+01:00" Target="Test" Version="1.0" CorrelationID="00Q564b2f91e1bf6">
  <Success />
</OTA_HotelInvCountNotifRS>

Request structure

OTA_HotelInvCountNotifRQ

Parent: None (Root element)

Mandatory: yes

Attributes:

Name

Mandatory

Description

TimeStamp

Yes

The format should respect the ISO 8601 2015-11-16T22:23:48+00:00

Target

Yes

When sending updates to the staging environment "Test" must be used.

When sending updates to the production environment "Production" must be used.

Version

Yes

The default value should be "1.000"

Child elements: POS (when using POS authentication. See Authentication methods for more information), Inventories

Inventories

Parent: OTA_HotelInvCountNotifRQ

Mandatory: yes

Attributes:

Name

Mandatory

Description

HotelCode

No

The Hotel-Spider hotel ID which you are updating

By default our system will search for the HotelCode attribute. Should this not be available, our system will try to identify the hotel based on the room ID as this is uniquely linked to one hotel.

HotelName

No

This attribute can be used for readability.

Child elements: Inventory

Inventory

Parent: Inventories

Mandatory: yes

Attributes: None

Children: StatusApplicationControl, InvCounts

StatusApplicationControl

Parent: Inventory

Mandatory: yes

Attributes:

Name

Mandatory

Description

Start

Yes

The format should respect the ISO 8601 2015-11-16

End

Yes

The format should respect the ISO 8601 2015-11-17

The End date is inclusive meaning that it will also be updated.

InvCode/InvTypeCode/RoomID

No

The Hotel-Spider room ID which you are updating

By default our system will search for the InvCode attribute. Should you have been using InvTypeCode in a previous development (for example: OTA version of the Booking.com interface ), we can configure our interface to ignore InvCode and work with InvTypeCode. The same goes for the RoomID attribute.

Children: None

Determining which level to update

Inventory is exclusively managed on room level in the Hotel-Spider system.

InvCounts

Parent: Inventory

Mandatory: yes

Attributes: None

Children: InvCount

InvCount

Parent: InvCounts

Mandatory: yes

Attributes:

Name	Mandatory	Description
Count	Yes	The number of rooms that is available for the Hotel-Spider system.
CountType	Yes	The default value should be "14" (Available Inventory)
ActionType	Yes	The default value should be "Allocation"

Children: None

Closing inventory

Setting "0" as number of available rooms does not close the room. The Hotel-Spider system dynamically manages availabilities and will increment the number of rooms after a cancellation. Thus should you wish to prevent a room from being sold, you need to transmit <OffSell OffSellValue="1"/>

OffSell

Parent: Inventory

Mandatory: No

Attributes:

Name	Mandatory	Description
OffSellValue	Yes	Possible values are "0" or "1".

Children: None

Closing inventory

Setting "0" as number of available rooms does not close the room. The Hotel-Spider system dynamically manages availabilities and will increment the number of rooms after a cancellation. Thus should you wish to prevent a room from being sold, you need to transmit <OffSell OffSellValue="1"/>

Response structure

OTA_HotelInvCountNotifRS

Parent: None (Root element)

Mandatory: yes

Attributes:

Name	Mandatory	Description
TimeStamp	Yes	The format will respect the ISO 8601 2015-11-16T22:23:48+00:00
Target	Yes	The same value, used in the request, will be returned.
Version	Yes	The value wil be "1.000"

Child elements: Success, Warnings, Errors

Success

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: None

Warnings

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: None

Warning

Parent: Warnings

Mandatory: yes (If Warnings is provided)

Attributes:

Name	Mandatory	Description
Type	Yes	OTA EWT type code
Code	Yes	OTA ERR error code
Status	Yes	Possible values: NotProcessed \| Incomplete \| Complete \| Unknown
ShortText	Yes	Textual explanation of the error.

Child elements: None

Errors

Parent: OTA Response root element

Mandatory: No

Attributes: None

Child elements: Error

Error

Parent: Error

Mandatory: yes (If Errors is provided)

Attributes:

Name	Mandatory	Description
Type	Yes	OTA EWT type code
Code	Yes	OTA ERR error code
Status	Yes	Possible values: NotProcessed \| Incomplete \| Complete \| Unknown
ShortText	Yes	Textual explanation of the error.

Child elements: None