--- title: "Retrieve the booking details list" method: GET path: "/api/v1/book/getbookings" tags: ["Booking"] --- # Retrieve the booking details list `GET /api/v1/book/getbookings` Retrieve the booking details list. ## Headers - `api-key` string - `customer-id` string - `affiliate-id` string ## Request body - RetrieveBookingsRequest - `creationStartDate` string, date-time, nullable — booking-in-start date for filter request, in ISO 8601 format (YYYY-MM-DD) - `creationEndDate` string, date-time, nullable — booking-in-end date for filter request, in ISO 8601 format (YYYY-MM-DD) - `pagingInfo` PagingInfo - `pageSize` integer - `paginationToken` string, nullable ## Response `200` Success - BookingDetailsPagination - `bookings` BookingDetails[], nullable - `bookingId` string — Booking Id - `bookingStatus` 'Confirmed' | 'Pending' | 'Failed' | 'Planned' | 'ConfirmationPending' | 'Created' | 'Initiated' - `cancellationStatus` 'Pending' | 'Failed' | 'CancellationPending' | 'Cancelled' - `providerConfirmationNumber` string — Confirmation number received from provider - `hotelConfirmationNumber` string, nullable — Hotel Confirmation number - `hotelCancellationNumber` string, nullable — Hotel Cancellation number - `providerCancellationNumber` string, nullable — Provider cancellation number - `roomConfirmationDetails` RoomConfirmationInfo[], nullable — Details of booked rooms - `rateId` string - `roomId` string - `providerConfirmationNumber` string - `hotelConfirmationNumber` string, nullable - `bookingStatus` 'Confirmed' | 'Pending' | 'Failed' | 'Planned' | 'ConfirmationPending' | 'Created' | 'Initiated' - `guests` Passenger[] - `title` string, nullable - `firstName` string, required - `lastName` string, required - `middleName` string, nullable - `suffix` string, nullable - `age` integer, required - `type` 'Adult' | 'Child', required - `email` string, nullable - `panCardNumber` string, nullable - `passportDetail` Passport - `passportNo` string, required - `passportIssueDate` string, date-time - `passportExpDate` string, date-time - `roomCancellationDetails` RoomCancellationInfo[], nullable — Details of booked rooms - `providerConfirmationNumber` string — Provider confirmation number - `hotelConfirmationNumber` string, nullable — Hotel confirmation number - `providerCancellationNumber` string — Provider cancellation number - `hotelCancellationNumber` string, nullable — Hotel cancellation number - `cancellationStatus` 'Pending' | 'Failed' | 'CancellationPending' | 'Cancelled' - `creationDate` string, date-time — Date time when the booking was done - `cancellationDate` string, date-time, nullable — Date time when the booking was cancelled - `tripStartDate` string, date-time — Trip start date - `tripEndDate` string, date-time — Trip end date - `hotel` HotelContent - `id` string — Unique Id of the hotel - `name` string — Name of the hotel - `geoCode` GeoCode - `lat` number, double — Latitude of the location - `long` number, double — Longitude of the location - `neighbourhoods` string[], nullable — Neighbourhoolds around the hotel - `contact` Contact - `phone` string - `address` Address - `line1` string, required - `line2` string, nullable - `city` City, required - `name` string, nullable - `code` string, required - `state` State, required - `name` string, nullable - `code` string, required - `country` Country, required - `name` string, nullable - `code` string, required - `postalCode` string, required - `email` string - `chainCode` string, nullable — Chain code of the hotel - `chainName` string, nullable — Chain name of the hotel - `type` string, nullable — Type of the hotel - `website` string, nullable — Website of the hotel - `descriptions` Description[] — Descriptions of the hotel - `type` string — Type of description - `text` string — Text of description - `category` string, nullable — Category of the hotel - `starRating` number, double — Star rating of the hotel - `facilities` Facility[], nullable — Facilities of the hotel - `name` string, nullable - `description` string, nullable - `id` string, nullable - `nearByAttractions` NearByAttraction[], nullable — Near by attractions from the hotel - `name` string - `distance` string, nullable - `description` string, nullable - `type` string, nullable - `images` Image[] — List of images of the hotel - `url` string, nullable — Url of the image - `links` ImageLink[], nullable — Link to images of different sizes - `url` string, nullable — Url of the image - `size` string, nullable — Size of the image - `caption` string, nullable — Caption of the image - `roomCodes` string[], nullable - `policies` Policy[], nullable — Policies of the hotel - `type` string - `text` string - `fees` Fee[], nullable — Any fee component charged by the hotel - `feeType` string - `text` string, nullable - `reviews` Review[], nullable — Reviews of the hotel - `provider` string, nullable - `count` integer - `rating` number, double - `url` string, nullable - `checkinInfo` CheckinInfo - `beginTime` string, nullable - `endTime` string, nullable - `instructions` string[], nullable - `specialInstructions` string[], nullable - `minAge` integer, nullable - `checkoutInfo` CheckoutInfo - `time` string, nullable - `heroImage` string, nullable — Hero image of the hotel - `rooms` Room[], nullable — Rooms static information - `id` string — Id of the room - `name` string — Name of the room - `code` string, nullable — Room code - `description` string — Room description - `beds` Bed[], nullable — Bed details for the room - `type` string — Type of bed, e.g. Double bed, King bed etc. - `description` string, nullable — Bed descriptive information - `count` integer — Bed count for the room - `size` string, nullable — Size of the bed - `isSmokingAllowed` boolean, nullable — Smoking allowed - `facilities` Facility[], nullable — Facilities avaiable as part of the room - `name` string, nullable - `description` string, nullable - `id` string, nullable - `images` Image[], nullable — Images of the room - `url` string, nullable — Url of the image - `links` ImageLink[], nullable — Link to images of different sizes - `url` string, nullable — Url of the image - `size` string, nullable — Size of the image - `caption` string, nullable — Caption of the image - `roomCodes` string[], nullable - `maxGuestsAllowed` integer, nullable — Maximum number of guests allowed - `maxAdultsAllowed` integer, nullable — Maximum adults allowd - `maxChildrenAllowed` integer, nullable — Maximum children allowed - `area` RoomArea - `squareMeters` string, nullable — Room area in square meters - `squareFeet` string, nullable — Room area in square feet - `text` string, nullable — Room area information - `views` string[], nullable — Views associated with the room - `type` string, nullable — Room Type - `isMappedRoom` boolean - `imageCount` integer — Total count of images of the hotel - `language` string, nullable — Culture information of the content - `attributes` Attributes[], nullable — Additional attributes - `key` string, nullable — Additional attributes key - `value` string, nullable — Additional attributes value - `desc` string, nullable — Additional attributes description - `leadPassenger` Passenger - `title` string, nullable - `firstName` string, required - `lastName` string, required - `middleName` string, nullable - `suffix` string, nullable - `age` integer, required - `type` 'Adult' | 'Child', required - `email` string, nullable - `panCardNumber` string, nullable - `passportDetail` Passport - `passportNo` string, required - `passportIssueDate` string, date-time - `passportExpDate` string, date-time - `cancellationToken` string, nullable — Cancellation Token to be used for cancelling booking - `totalRate` number, double — Total Booking Rate - `currency` string, nullable — Booking Currency - `correlationId` string, nullable — Booking Correlation Id - `pageSize` integer - `nextPageToken` string, nullable - `isDone` boolean ## Other responses - `400` — ClientSideError - `500` — ServerSideError --- [API](https://skmtc.net/zentrumhub/apis/hotelcontent-api.md) · [All operations](https://skmtc.net/zentrumhub/apis/hotelcontent-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zentrumhub/hotelcontent-api/revisions/9fa4830db488/schema)