Basket Row
An object comprised of the current details of the users basket.
Example object:
{
adults: 1,
children: 0
startDate: "Sat Oct 29 2022 20:05:22 GMT+0100",
endDate: "Sun Oct 30 2022 20:05:22 GMT+0000",
isStale: undefined,
promoCode: "roomstayPromo",
promoCodeStatus: "new",
promoOnly: false,
rate: {
cancelPolicyCode: "NON",
code: "VPKG",
description: "Description here",
...
},
room: {
name: "Delux Room",
longDescription: "Long description here",
images: [URL, URL, URL],
....
},
uniqId: "..."
}
adults
Number of adults registered on the current booking.
Type: integer
children
Number of children registered on the current booking.
Type: integer
startDate
Check-in date of the of the booking.
Type: string
Format: EEE MMM DD YYYY HH:mm:ss zzzzz
endDate
Check-out date of the of the booking.
Type: string
Format: EEE MMM DD YYYY HH:mm:ss zzzzz
isStale
Internal use only.
Type: string
promoCode
Promotional code currently applied to the basket.
Type: string
promoCodeStatus
The status of the Promotional code currently applied.
Type: string
promoOnly
Internal use only.
Type: string
rate
An object containing terms relating to the room which has been booked, with a long room description.
Type: RoomRate object
room
An object containing descriptors relating to the room which has been booked.
Type: Room object
uniqId
Generated on object creation. Will uniquely identify a user's booking within the current session.
Type: string