Skip to content
DEVELOPERS

Post inventories

POST
/api/public/v1/inventories

In success case, HTTP Code 202 will be returned. This endpoint accepts an array of inventory objects.

Parameters

Header Parameters

ReplyTo
required
string

Request Body required

List of inventories to process

One of:
Array<object>
>= 1 items <= 1000 items
object
clientCode
required

Unique code identifying the client.

string
createDateTime
required

Timestamp when the record was created.

string format: date-time
propertyCode
required

Unique code identifying the property.

string
occupancyDate
required

Date for which the occupancy data applies.

string format: date
correlationId
required

Correlation ID for tracking purposes.

string
roomTypeInventories
required

List of room type inventories.

Array<object>
>= 1 items
object
roomTypeCapacity
required

Accommodation capacity of the room type.

integer format: int32
roomsNotAvailableMaintenance
required

Number of rooms not available due to maintenance.

integer format: int32
roomsNotAvailableOther

Number of rooms not available due to other reasons.

integer format: int32
roomsSold
required

Number of rooms sold.

integer format: int32
roomTypeCode
required

Code identifying the room type.

string
transientSold

Number of transient rooms sold.

integer format: int32
groupSold

Number of group rooms sold.

integer format: int32
virtualRoomTypeInventories

List of virtual room type inventories.

Array<object>
object
roomTypeCapacity
required

Accommodation capacity of the room type.

integer format: int32
roomsNotAvailableMaintenance
required

Number of rooms not available due to maintenance.

integer format: int32
roomsNotAvailableOther

Number of rooms not available due to other reasons.

integer format: int32
roomsSold
required

Number of rooms sold.

integer format: int32
roomTypeCode
required

Code identifying the room type.

string
transientSold

Number of transient rooms sold.

integer format: int32
groupSold

Number of group rooms sold.

integer format: int32
Examples

Hotels that do not have virtual room types

[
  {
    "clientCode": "TESTCLIENT",
    "propertyCode": "TESTHOTELCODE",
    "createDateTime": "2024-11-22T04:35:19.906Z",
    "occupancyDate": "2024-10-07",
    "correlationId": "11292d1b6-55c8-4c84-a09c-7bb74403d156",
    "roomTypeInventories": [
      {
        "roomTypeCapacity": 20,
        "roomsNotAvailableMaintenance": 1,
        "roomsNotAvailableOther": 0,
        "roomsSold": 10,
        "roomTypeCode": "KING",
        "transientSold": 9,
        "groupSold": 1
      },
      {
        "roomTypeCapacity": 17,
        "roomsNotAvailableMaintenance": 1,
        "roomsNotAvailableOther": 0,
        "roomsSold": 9,
        "roomTypeCode": "DOUBLE",
        "transientSold": 7,
        "groupSold": 2
      }
    ]
  },
  {
    "clientCode": "TESTCLIENT",
    "propertyCode": "TESTHOTELCODE",
    "createDateTime": "2024-11-22T04:35:19.906Z",
    "occupancyDate": "2024-10-08",
    "correlationId": "11292d1b6-55c8-4c84-a09c-7bb74403d156",
    "roomTypeInventories": [
      {
        "roomTypeCapacity": 20,
        "roomsNotAvailableMaintenance": 1,
        "roomsNotAvailableOther": 0,
        "roomsSold": 15,
        "roomTypeCode": "KING",
        "transientSold": 10,
        "groupSold": 5
      },
      {
        "roomTypeCapacity": 17,
        "roomsNotAvailableMaintenance": 0,
        "roomsNotAvailableOther": 0,
        "roomsSold": 12,
        "roomTypeCode": "DOUBLE",
        "transientSold": 10,
        "groupSold": 2
      }
    ]
  }
]

Responses

202

Inventories accepted

UUID of request

string

400

Bad request due to invalid input.

object
error
required

HTTP status message

string
exception

Fully qualified exception type

string
message
required

Exception / error message

string
path
string
status
required

HTTP status code for the error

integer format: int32
timestamp
required

Date and time the error occurred

string format: date-time

500

Internal server error.

object
error
required

HTTP status message

string
exception

Fully qualified exception type

string
message
required

Exception / error message

string
path
string
status
required

HTTP status code for the error

integer format: int32
timestamp
required

Date and time the error occurred

string format: date-time