Get Booking List

Description: Get booking list

Path: /api/v1/reservation/getBookingList

Method: GET

Request

Attributes

* = required

hotelSn*

integer

Identify of hotel

startDate

string

Optional. Filter by checkInDatePlan Format: Y-m-d

endDate

string

Optional. Filter by checkInDatePlan Format: Y-m-d

bookingType

integer

Possible enum values: 1 = Hourly 2 = Overnight 3 = Daily

bookingStatus

integer

Possible enum values: 1 = Upcoming 9 = Checked-in 8 = Awaiting G2J Processing 4 = No-show 3 = Cancelled 2 = Completed 10 = Awaiting User Confirmation 5 = Pending Payment

keyword

string

Search by keyword based on bookingNo

bookingNoList

array

List of booking numbers. Each value separated by "," Note: To ensure reliable processing, please limit the number of bookings sent in each request to a maximum of 100~200.

page

integer

Page’s number

limit

integer

The maximum number of records to include on each page.

Response

Attributes

userBookingSn

integer

Identify of booking

bookingNo

string

Go2Joy’s Identity of booking

hotelSn

integer

Identify of hotel

hotelName

string

Hotel’s name

roomTypeSn

integer

Identify of room type

roomTypeName

string

Room type’s name

nickName

string

User’s nick name

mobile

string

Phone number of user

checkIn

string

Check-in time Format: Y-m-d H:i:s

checkOut

string

Check-out time Format: Y-m-d H:i:s

bookingType

integer

Possible enum values: 1 = Hourly 2 = Overnight 3 = Daily

bookingStatus

integer

Possible enum values: 1 = Upcoming 9 = Checked-in 8 = Awaiting G2J Processing 4 = No-show 3 = Cancelled 2 = Completed 10 = Awaiting User Confirmation 5 = Pending Payment

paymentWay

integer

Possible enum values: 2 = Pay at hotel 3 = Pay in advance

paymentStatus

integer

Possible enum values: 0 = Awaiting 1 = Successful 2 = Failed 3 = Refunded

totalAmount

integer

The total booking amount needs to be paid at once for this booking, including extra fee if you’re booking at high demand time. This does not include promotion such as flash sale, direct discount

totalGo2JoyDiscount

integer

Total discount from Go2Joy

totalHotelDiscount

integer

Total discount from Hotel

amountFromUser

integer

The total booking amount needs to be paid from user

couponName

string

Coupon’s name applied on this booking.

bonusHour

integer

Number of bonus hours

flashSale

boolean

Applied/Not applied flash sale

directDiscount

boolean

Applied/Not applied direct discount

highDemand

boolean

Applied/Not applied high demand

reasonForTransfer

string

The reason for transferred

reasonForCancellation

string

The reason for cancelled

reasonForNoShow

string

The reason for no-show

reasonForComplete

string

The reason for completed

createTime

string

Format: Y-m-d H:i:s

lastUpdate

string

Format: Y-m-d H:i:s

Example

PreviousReservation APIsNextFetch Changed Booking List

Last updated