Get Booking List

Description: Get booking list

Path: /api/v1/reservation/getBookingList

Method: GET

Request

Attributes

* = required

chevron-righthotelSn*hashtag

integer

Identify of hotel

chevron-rightstartDatehashtag

string

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

chevron-rightendDatehashtag

string

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

chevron-rightbookingTypehashtag

integer

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

chevron-rightbookingStatushashtag

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

chevron-rightkeywordhashtag

string

Search by keyword based on bookingNo

chevron-rightbookingNoListhashtag

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.

chevron-rightpagehashtag

integer

Page’s number

chevron-rightlimithashtag

integer

The maximum number of records to include on each page.

Response

Attributes

chevron-rightuserBookingSnhashtag

integer

Identify of booking

chevron-rightbookingNohashtag

string

Go2Joy’s Identity of booking

chevron-righthotelSnhashtag

integer

Identify of hotel

chevron-righthotelNamehashtag

string

Hotel’s name

chevron-rightroomTypeSnhashtag

integer

Identify of room type

chevron-rightroomTypeNamehashtag

string

Room type’s name

chevron-rightnickNamehashtag

string

User’s nick name

chevron-rightmobilehashtag

string

Phone number of user

chevron-rightcheckInhashtag

string

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

chevron-rightcheckOuthashtag

string

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

chevron-rightbookingTypehashtag

integer

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

chevron-rightbookingStatushashtag

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

chevron-rightpaymentWayhashtag

integer

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

chevron-rightpaymentStatushashtag

integer

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

chevron-righttotalAmounthashtag

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

chevron-righttotalGo2JoyDiscounthashtag

integer

Total discount from Go2Joy

chevron-righttotalHotelDiscounthashtag

integer

Total discount from Hotel

chevron-rightamountFromUserhashtag

integer

The total booking amount needs to be paid from user

chevron-rightcouponNamehashtag

string

Coupon’s name applied on this booking.

chevron-rightbonusHourhashtag

integer

Number of bonus hours

chevron-rightflashSalehashtag

boolean

Applied/Not applied flash sale

chevron-rightdirectDiscounthashtag

boolean

Applied/Not applied direct discount

chevron-righthighDemandhashtag

boolean

Applied/Not applied high demand

chevron-rightreasonForTransferhashtag

string

The reason for transferred

chevron-rightreasonForCancellationhashtag

string

The reason for cancelled

chevron-rightreasonForNoShowhashtag

string

The reason for no-show

chevron-rightreasonForCompletehashtag

string

The reason for completed

chevron-rightcreateTimehashtag

string

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

chevron-rightlastUpdatehashtag

string

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

Example

Last updated