Get Booking list#
The following sections describe how to retrieve the booking list from a specific date.
The input parameter “localDateStart” has to be formated like te following : YYYY-MM-DD ie : 2023-04-19 The input parameter “confirmedStartDate” has to be formated like te following : YYYY-MM-DD ie : 2023-04-19 The input parameter “confirmedEndDate” has to be formated like te following : YYYY-MM-DD ie : 2023-04-19 The input parameter “cancelledStartDate” has to be formated like te following : YYYY-MM-DD ie : 2023-04-19 The input parameter “cancelledEndDate” has to be formated like te following : YYYY-MM-DD ie : 2023-04-19
Path
GET admin/house-of-travel-portal/bookings
Input parameters
Field |
Mandatory |
Type |
Description |
Example |
|---|---|---|---|---|
localDateStart |
Y |
string |
Date from which the booking need to be retreive |
2023-05-01 |
isSandboxed |
N |
boolean |
if the output includes sandbox data or not |
true (default value : false) |
bookingStates |
N |
string |
list of booking states we want for the booking list |
OPEN,CONFIRMED,PENDING,PAYMENT,PAYMENT,FAILED,CANCELLED,EXPIRED (default value : all ) |
pageSize |
N |
integer |
number of result per page ( max 25 ) |
20 |
pageIndex |
N |
integer |
page number to display |
1 |
confirmedStartDate |
N |
string |
Date from which the booking with status CONFIRMED are searched |
|
confirmedEndDate |
N |
string |
Date to which the booking with status CONFIRMED are searched |
|
cancelledStartDate |
N |
string |
Date from which the booking with status CANCELLED are searched |
|
cancelledEndDate |
N |
string |
Date to which the booking with status CANCELLED are searched |
Output
Field |
Type |
Description |
Example |
|---|---|---|---|
supplierReference |
string |
code of the booking |
dw6ef4 |
contactFullName |
string |
Last name and first name of the main passenger |
Dupond marc |
channel |
string |
channel used for the booking |
House of travel |
utcCreatedAt |
string |
date of the booking |
4/5/2024 |
utcVoucherCreatedAt |
String |
Date & time when the voucher is created by the booking system in UTC timezone. |
“2023-06-19T14:00:32Z” |
utcConfirmedAt |
String |
Confirmation date and time of the booking in UTC timezone. |
“2023-04-19T14:00:32Z” |
utcCancelledAt |
String |
Cancellation date and time of the booking in UTC timezone. |
“2023-04-19T14:00:32Z” |
isSandboxed |
string |
information if the booking is in sandbox environment or not |
TRUE |
localStartDateTime |
string |
date and time of the activity |
4/10/2024 9:30 |
price |
string |
price the customer paid |
35 |
currency |
string |
currency used by the customer for the booking |
EUR |
status |
string |
status of the booking |
COMFIRMED |
owningSecurityPrincipalUserEmail |
string |
email of the security principal user that created the booking |
Response Body
{
"pageNumber": 1,
"totalResults": 41,
"resultsPerPage": 10,
"items": [
{
"supplierReference": "AV5SAS",
"contactFullName": "TEST Test",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-25T18:34:49Z",
"utcVoucherCreatedAt": "2023-04-25T18:36:30Z",
"isSandboxed": true,
"localStartDateTime": "2023-04-29T09:00:00",
"price": "535.5",
"currency": "NZD",
"status": "CONFIRMED",
"owningSecurityPrincipalUserEmail": "email.test@hot.co.nz"
},
{
"supplierReference": "LSVPNS",
"contactFullName": "MURRAY Patrick",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-21T03:01:47Z",
"utcVoucherCreatedAt": "2023-04-21T03:03:40Z",
"isSandboxed": true,
"localStartDateTime": "2023-06-15T08:00:00",
"price": "128.5",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "KQG5VR",
"contactFullName": "O'MALLEY Suzy",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-21T02:47:54Z",
"utcVoucherCreatedAt": "2023-04-21T02:50:07Z",
"isSandboxed": true,
"localStartDateTime": "2023-06-19T10:00:00",
"price": "3.3",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "VWPCGZ",
"contactFullName": "POTTER Harry",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-19T14:00:32Z",
"utcVoucherCreatedAt": "2023-04-19T14:04:13Z",
"isSandboxed": true,
"localStartDateTime": "2023-05-17T11:30:00",
"price": "769.8",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "GGK6VM",
"contactFullName": "POTTER Harry",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-19T13:37:18Z",
"utcVoucherCreatedAt": "2023-04-19T13:40:51Z",
"isSandboxed": true,
"localStartDateTime": "2023-05-24T13:00:00",
"price": "350.6",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "RH4KAJ",
"contactFullName": "POTTER Harry",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-17T10:04:57Z",
"utcVoucherCreatedAt": "2023-04-17T10:07:46Z",
"isSandboxed": true,
"localStartDateTime": "2023-05-05T09:00:00",
"price": "355.6",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "5VNFUQ",
"contactFullName": "POTTER Harry",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-17T09:53:55Z",
"utcVoucherCreatedAt": "2023-04-17T09:57:30Z",
"isSandboxed": true,
"localStartDateTime": "2023-05-01T09:00:00",
"price": "2177.1000000000004",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "S3RAXF",
"contactFullName": "TEST Eric",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-13T14:24:59Z",
"utcVoucherCreatedAt": "2023-04-13T14:29:16Z",
"isSandboxed": true,
"localStartDateTime": "2023-04-14T09:00:00",
"price": "1423",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "3X85MD",
"contactFullName": "O'MALLEY Suzy",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-12T23:15:24Z",
"utcVoucherCreatedAt": "2023-04-12T23:16:54Z",
"isSandboxed": true,
"localStartDateTime": "2023-08-14T08:00:00",
"price": "248",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "3SGR4W",
"contactFullName": "TEST Test",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-04-12T13:28:08Z",
"utcVoucherCreatedAt": "2023-04-12T13:29:24Z",
"isSandboxed": true,
"localStartDateTime": "2023-04-16T17:00:00",
"price": "433.6",
"currency": "NZD",
"status": "CONFIRMED"
},
{
"supplierReference": "Y27JU9",
"contactFullName": "OMALLEY Suzy",
"channel": "HouseofTravel",
"utcCreatedAt": "2023-10-05T01:34:47Z",
"utcConfirmedAt": "2023-10-05T01:35:58Z",
"utcVoucherCreatedAt": "2023-10-05T01:35:52Z",
"isSandboxed": true,
"localStartDateTime": "2023-12-14T08:00:00",
"price": "699.7",
"currency": "NZD",
"status": "CONFIRMED"
}
]
}
Status code
Code |
Description |
|---|---|
200 |
Successful retrieve of bookings |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal server error |