save reservations

POST

/api/public/v1/reservation

Save reservations

Parameters

Header Parameters

ReplyTo

required

string

Request Body^required

Reservations to save

Array<object>

>= 1 items

object

bookingDateTime

required

Date of the booking

string format: date-time

lastModifiedDateTime

required

Date of last modification

string format: date-time

lastBookedPropertyCode

Last booked property code

string

cancellationDateTime

Date reservation was cancelled

string format: date-time

cancellationReason

Reason reservation was cancelled

string

channel

Booking channel reservation was made with

string

clientCode

required

Client code associated with reservation

string

confirmationNumber

Confirmation number of the reservation

string

correlationId

required

Correlation ID

string

multiReservationId

Multi reservation id

string

nationality

Origin country of guest making reservation

string

numberOfRooms

required

Number of rooms in reservation

integer format: int32

primarySharer

Primary sharer

boolean

propertyCode

required

Property code associated with this reservation

string

reservationId

required

Id of reservation

string

roomStays

required

Array<object>

>= 1 items

object

arrivalDate

required

Date of arrival

string format: date

bookedRoomTypeCode

Booked room type code

string

departureDate

required

Date of departure

string format: date

groupBlockCode

Group block code

string

roomTypeCode

required

Room type code

string

marketSegmentCode

required

Market segment code

string

numberOfAdults

required

Number of adults

integer format: int32

numberOfChildren

required

Number of children

integer format: int32

numberOfInfants

Number of infants

integer format: int32

childAgeBuckets

Child age buckets

Array<object>

>= 1 items

object

minimumAge

required

Minimum age

number

maximumAge

required

Maximum age

number

numberOfChildren

required

Number of children

number

currencyCode

required

Currency code

string

rateCode

required

Rate code

string

rates

required

Array<object>

>= 1 items

object

endDate

required

End date

string format: date

grossRateValue

Gross rate

number

rateValue

required

Rate value

number

startDate

required

Start date

string format: date

roomNumber

Room number

string

services

Array<object>

object

endDate

required

End date of service

string format: date

inclusive

required

Is the service inclusive

boolean

reservationPackage

Reservation package

boolean

roomRevenuePackage

Room revenue package

boolean

serviceName

required

Name of service

string

serviceValue

required

Value of service

number

startDate

required

Start date of service

string format: date

sourceBookingCode

Source booking code

string

profiles

Array<object>

>= 1 items

object

required

string

profileType

required

Type of profile

string

Allowed values: TRAVEL_AGENT COMPANY

context

Profile context

string

name

required

Profile name

string

shareId

Share id

string

sharers

List of sharers

Array<string>

status

required

Status of reservation

string format: enum

Allowed values: RESERVED CANCELLED IN_HOUSE CHECKED_OUT NO_SHOW

stayRevenue

required

object

daily

required

Array<object>

object

occupancyDate

required

string format: date

netBeverageRevenue

Net beverage revenue

number

netFoodRevenue

Net food revenue

number

netOtherRevenue

Net other revenue

number

netRoomRevenue

required

Net room revenue

number

netTotalRevenue

required

Net total revenue

number

grossTotalRevenue

Gross total revenue

number

ticketPrice

Ticket price

number

netTicketPrice

Net ticket price

number

summary

object

totalTicketRevenue

Total ticket revenue

number

netTotalTicketRevenue

Net total ticket revenue

number

Examples

[
  {
    "clientCode": "TESTCLIENT",
    "propertyCode": "TESTHOTELCODE",
    "correlationId": "6825ceed2ea6702a68b8e6",
    "lastModifiedDateTime": "2021-10-14T12:55:20.311Z",
    "reservationId": "219849-839960",
    "confirmationNumber": "839960",
    "status": "RESERVED",
    "bookingDateTime": "2022-01-01T12:23:34Z",
    "numberOfRooms": 1,
    "multiReservationId": null,
    "shareId": "2321",
    "cancellationDateTime": null,
    "cancellationReason": null,
    "channel": "GDS",
    "nationality": "NL",
    "roomStays": [
      {
        "arrivalDate": "2021-07-03",
        "departureDate": "2021-07-04",
        "roomTypeCode": "SGC",
        "bookedRoomTypeCode": "DBL",
        "marketSegmentCode": "CORP",
        "groupBlockCode": "Grp1",
        "sourceBookingCode": "AA",
        "roomNumber": "100",
        "numberOfAdults": 1,
        "numberOfChildren": 2,
        "currencyCode": "USD",
        "rateCode": "FLRA3",
        "rates": [
          {
            "startDate": "2021-07-03",
            "endDate": "2021-07-04",
            "rateValue": "68.87",
            "grossRateValue": "82.64"
          }
        ],
        "childAgeBuckets": [
          {
            "minimumAge": "3",
            "maximumAge": "8",
            "numberOfChildren": "2"
          }
        ],
        "services": [
          {
            "startDate": "2021-07-03",
            "endDate": "2021-07-04",
            "serviceName": "SPCT",
            "serviceValue": 2.83,
            "inclusive": false,
            "reservationPackage": false,
            "roomRevenuePackage": false
          }
        ]
      },
      {
        "arrivalDate": "2021-07-05",
        "departureDate": "2021-07-06",
        "roomTypeCode": "SGC",
        "bookedRoomTypeCode": "DBL",
        "marketSegmentCode": "CORP",
        "groupBlockCode": "Grp2",
        "sourceBookingCode": "BB",
        "roomNumber": "101",
        "numberOfAdults": "1",
        "numberOfChildren": "2",
        "currencyCode": "USD",
        "rateCode": "FLRA4",
        "rates": [
          {
            "startDate": "2021-07-05",
            "endDate": "2021-07-06",
            "rateValue": "89.99",
            "grossRateValue": "105.67"
          },
          {
            "startDate": "2021-07-07",
            "endDate": "2021-07-08",
            "rateValue": "78.87",
            "grossRateValue": "92.64"
          }
        ],
        "childAgeBuckets": [
          {
            "minimumAge": "5",
            "maximumAge": "10",
            "numberOfChildren": "1"
          }
        ],
        "services": [
          {
            "startDate": "2021-07-05",
            "endDate": "2021-07-06",
            "serviceName": "BKF",
            "serviceValue": 10,
            "inclusive": false,
            "reservationPackage": false,
            "roomRevenuePackage": false
          }
        ]
      }
    ],
    "profiles": [
      {
        "id": "7564321",
        "name": "IDeaS",
        "profileType": "COMPANY",
        "context": null
      }
    ],
    "stayRevenue": {
      "daily": [
        {
          "occupancyDate": "2021-07-03",
          "netRoomRevenue": "68.87",
          "netFoodRevenue": "0.00",
          "netBeverageRevenue": "0.00",
          "netOtherRevenue": "2.83",
          "netTicketPrice": "80.00",
          "ticketPrice": "100.00",
          "netTotalRevenue": "151.7",
          "grossTotalRevenue": "185.47"
        },
        {
          "occupancyDate": "2021-07-04",
          "netRoomRevenue": "68.87",
          "netFoodRevenue": "0.00",
          "netBeverageRevenue": "0.00",
          "netOtherRevenue": "2.83",
          "netTicketPrice": "80.00",
          "ticketPrice": "100.00",
          "netTotalRevenue": "151.7",
          "grossTotalRevenue": "185.47"
        }
      ],
      "summary": {
        "netTotalTicketRevenue": "160.00",
        "totalTicketRevenue": "200.00"
      }
    }
  }
]

Responses

202

Reservations accepted

UUID of request

string

400

Bad request

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

save reservations

Parameters

Header Parameters

Request Body required

Examples

Responses

202

400

500

Request Body^required