Retrieve Booking
Discover how to use Retrieve API calls to retrieve existing itineraries. This can be called directly with your API key with booking reference id. It returns details about a booking details associated with the itinerary id along with cancel links to cancel the booking.
Parameters
Name
Description
Accept
string
( header )
Must be application/json
Accept - Encoding
string
( header )
Must be gzip
Authorization
string
( header )
Must be Your PID
Must be Your API Key
Customer-Ip
string
( header )
Must be IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.
Also used for fraud recovery and other important analytics.
action
string
( query )
Must be "bookingDetail" as parameter
Action methods in Web API controller can have one or more parameters of different types. It can be either primitive type or complex type. Web API binds action method parameters either with URL's query string or with request body depending on the parameter type.
apiKey
string
( query )
Must be a valid API Key
The API Key provided to you is critical to the security of your request data – treat it like a password. Never include the raw value in any publicly accessible site or app code. You will be provided with an API key when you are approved to integrate TPS API.
ModeType
string
( query )
Must be either "Test" or "LIVE"
Your application must be approved from Adivaha Personnel. All the transactions will be treated as LIVE once the parameter is set to LIVE.
reference
string
( query )
The Reference no generated at the time of booking.
order_id
string
Order Id that received from preConfirm method.
REQUEST
API Endpoint: https://your-end-point/api/v1/travel-api/activities/
header: array( 'Content-Type:application/json', 'Accept-encoding: gzip', 'PID:'ADD-YOUR-PID', 'x-api-key:'ADD-YOUR-KEY' ); GET: https://your-end-point/api/v1/travel-api/activities.php?action=bookingDetail&reference=270-399717&order_id=626153A1B94FD
Response
The API returns an HTTP response, which generally includes the result of the request invocation
{
"status": 200,
"status_message": "OK",
"responseData": {
"operationId": "1c9357c410a280bb",
"auditData": {
"processTime": 0,
"time": "2022-04-21T12:25:53.107Z",
"serverId": "blank",
"environment": "blank"
},
"booking": {
"reference": "270-399717",
"status": "CONFIRMED",
"currency": "EUR",
"pendingAmount": 69.46,
"agency": {
"code": 30543,
"branch": 1,
"comments": "",
"sucursal": {
"name": "PRUEBAS SISTEMAS MINORISTA SUC 1 - 1",
"street": "PEREZ GALDOS 1",
"zip": "07006",
"city": "PALMA DE MALLORCA",
"email": "mfiol@activitiesbank.com",
"region": "07"
}
},
"creationDate": "2022-04-21T13:52:12.000Z",
"paymentData": {
"paymentType": {
"code": "P"
},
"invoicingCompany": {
"code": "HBD",
"name": "BEDSONLINE, S.L.U.",
"registrationNumber": "ESB28931681"
},
"description": "Name Beds on Line, Bank: BBVA(Pl. L' Olivar 6, 07002 Palma, Baleares, España) Account:ES9101824899160200711397, SWIFT:BBVAESMMXXX, 7 days prior to clients arrival (except group bookings with fixed days in advance at the time of the confirmation) . Please indicate our reference number when making payment. Thank you for your cooperation., NOTICE: SWIFT CODE CHANGED"
},
"clientReference": "5F816749F3A14",
"holder": {
"name": "TEST",
"title": "",
"email": "praveen@thewebconz.com",
"mailing": false,
"surname": "BOOKING",
"telephones": [
"8802273456"
]
},
"total": 78.04,
"totalNet": 69.46,
"activities": [
{
"status": "CONFIRMED",
"supplier": {
"name": "HOTELBEDS SPAIN, S.L.U",
"vatNumber": "ESB28916765"
},
"comments": [
{
"type": "CONTRACT_REMARKS",
"text": "Meeting point: At the Hotel // End point: at the Hotel // Duration: 4 hours // Inclusions: Transport, Guide, Monuments // Exclusions: Tipping or any other meal which is not mentioned // Supplier name: Distinct Destinations Private Ltd // Supplier emergency phone: 00 91 9818419730 // Voucher type: Printed voucher or E-voucher. Print and bring the voucher or show the voucher on your mobile device to enjoy the activity. // Voucher validity: Date of service only. // Recommendations: Children require an adult aged 16 or above to purchase tickets on their behalf, and must be accompanied by this adult when entering the park. All guests under the same reservation must enter the park together. Tickets must be used on the specific day selected. Tickets can only be used once. Re-entry not allowed. Passport is required on the travel date // \t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n"
}
],
"type": "TICKET",
"vouchers": [],
"activityReference": "270-399717",
"code": "E-E10-IN-JACITY",
"name": "Half Day City Tour",
"modality": {
"code": "PRIVATE@STANDARD|ENG|13:30",
"name": "Private english 13:30",
"rates": [
{
"freeCancellation": false,
"rateDetails": [
{
"languages": [
{
"code": "en"
}
]
}
]
}
],
"amountUnitType": "PAX"
},
"dateFrom": "2022-04-30",
"dateTo": "2022-04-30",
"cancellationPolicies": [
{
"dateFrom": "2022-04-29T00:00:00.000Z",
"amount": 78.04
}
],
"paxes": [
{
"name": "Test",
"mailing": false,
"surname": "Booking",
"customerId": "1",
"age": 30,
"paxType": "AD",
"passport": ""
}
],
"questions": [
{
"question": {
"code": "EMAILCONTACTO",
"text": "Email – Client contact introduced in the booking process",
"required": true
},
"answer": "praveen@thewebconz.com"
},
{
"question": {
"code": "HOTEL_NAME",
"text": "Please advise the name of your hotel",
"required": true
},
"answer": "oyohotel"
},
{
"question": {
"code": "TLFCONTACTO",
"text": "Telephone – Client contact introduced in the booking process",
"required": true
},
"answer": "8802273456"
}
],
"id": "270#O#1",
"agencyCommission": {
"percentage": 11,
"amount": -8.58,
"vatAmount": 0
},
"contactInfo": {
"country": {
"destinations": [
{
"code": "JAI",
"name": "Jaipur"
}
]
}
},
"amountDetail": {
"paxAmounts": [
{
"paxType": "ADULT",
"amount": 78.04
}
],
"totalAmount": {
"amount": 78.04
}
},
"extraData": [
{
"id": "INFO_TTOO_BEARING_AMOUNT",
"value": "69.460"
},
{
"id": "INFO_TTOO_BEARING_AMOUNT_CURRENCY",
"value": "EUR"
},
{
"id": "INFO_TTOO_SERVICE_AMOUNT",
"value": "8.58"
}
],
"providerInformation": {
"name": "DISTINCT DESTINATIONS PVT LTD "
},
"content": {
"name": "Half Day City Tour",
"detailedInfo": [
""
],
"featureGroups": [
{
"groupCode": "DRINKS",
"excluded": [
{
"featureType": "DRINKSNOT",
"description": "Drinks"
}
]
},
{
"groupCode": "MEAL",
"excluded": [
{
"featureType": "FOODNOT",
"description": "Meal"
}
]
}
],
"location": {
"startingPoints": [
{
"type": "ATTRACTION_VENUE",
"meetingPoint": {
"type": "ADDRESS",
"country": {
"code": "IN",
"name": "India",
"destinations": [
{
"code": "JAI",
"name": "Jaipur"
}
]
},
"description": "Half Day City Tour"
}
}
]
},
"media": {
"images": [
{
"visualizationOrder": 1,
"mimeType": "image/jpeg",
"urls": [
{
"dpi": 72,
"height": 75,
"width": 100,
"resource": "https://media.activitiesbank.com/16457/ENG/S/DSC_0035_resized.JPG",
"sizeType": "SMALL"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/XL/DSC_0035_resized.JPG",
"sizeType": "XLARGE"
},
{
"dpi": 72,
"height": 480,
"width": 640,
"resource": "https://media.activitiesbank.com/16457/ENG/B/DSC_0035_resized.JPG",
"sizeType": "LARGE2"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/LPP/DSC_0035_resized.JPG",
"sizeType": "RAW"
},
{
"dpi": 72,
"height": 200,
"width": 267,
"resource": "https://media.activitiesbank.com/16457/ENG/L/DSC_0035_resized.JPG",
"sizeType": "LARGE"
},
{
"dpi": 72,
"height": 130,
"width": 173,
"resource": "https://media.activitiesbank.com/16457/ENG/M/DSC_0035_resized.JPG",
"sizeType": "MEDIUM"
}
]
},
{
"visualizationOrder": 2,
"mimeType": "image/jpeg",
"urls": [
{
"dpi": 72,
"height": 75,
"width": 100,
"resource": "https://media.activitiesbank.com/16457/ENG/S/DSC_0760.JPG",
"sizeType": "SMALL"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/XL/DSC_0760.JPG",
"sizeType": "XLARGE"
},
{
"dpi": 72,
"height": 480,
"width": 640,
"resource": "https://media.activitiesbank.com/16457/ENG/B/DSC_0760.JPG",
"sizeType": "LARGE2"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/LPP/DSC_0760.JPG",
"sizeType": "RAW"
},
{
"dpi": 72,
"height": 200,
"width": 267,
"resource": "https://media.activitiesbank.com/16457/ENG/L/DSC_0760.JPG",
"sizeType": "LARGE"
},
{
"dpi": 72,
"height": 130,
"width": 173,
"resource": "https://media.activitiesbank.com/16457/ENG/M/DSC_0760.JPG",
"sizeType": "MEDIUM"
}
]
},
{
"visualizationOrder": 3,
"mimeType": "image/jpeg",
"urls": [
{
"dpi": 72,
"height": 75,
"width": 100,
"resource": "https://media.activitiesbank.com/16457/ENG/S/DSC_0834.JPG",
"sizeType": "SMALL"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/XL/DSC_0834.JPG",
"sizeType": "XLARGE"
},
{
"dpi": 72,
"height": 480,
"width": 640,
"resource": "https://media.activitiesbank.com/16457/ENG/B/DSC_0834.JPG",
"sizeType": "LARGE2"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/LPP/DSC_0834.JPG",
"sizeType": "RAW"
},
{
"dpi": 72,
"height": 200,
"width": 267,
"resource": "https://media.activitiesbank.com/16457/ENG/L/DSC_0834.JPG",
"sizeType": "LARGE"
},
{
"dpi": 72,
"height": 130,
"width": 173,
"resource": "https://media.activitiesbank.com/16457/ENG/M/DSC_0834.JPG",
"sizeType": "MEDIUM"
}
]
},
{
"visualizationOrder": 4,
"mimeType": "image/jpeg",
"urls": [
{
"dpi": 72,
"height": 75,
"width": 100,
"resource": "https://media.activitiesbank.com/16457/ENG/S/jaiour%201.JPG",
"sizeType": "SMALL"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/XL/jaiour%201.JPG",
"sizeType": "XLARGE"
},
{
"dpi": 72,
"height": 480,
"width": 640,
"resource": "https://media.activitiesbank.com/16457/ENG/B/jaiour%201.JPG",
"sizeType": "LARGE2"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/LPP/jaiour%201.JPG",
"sizeType": "RAW"
},
{
"dpi": 72,
"height": 200,
"width": 267,
"resource": "https://media.activitiesbank.com/16457/ENG/L/jaiour%201.JPG",
"sizeType": "LARGE"
},
{
"dpi": 72,
"height": 130,
"width": 173,
"resource": "https://media.activitiesbank.com/16457/ENG/M/jaiour%201.JPG",
"sizeType": "MEDIUM"
}
]
},
{
"visualizationOrder": 5,
"mimeType": "image/jpeg",
"urls": [
{
"dpi": 72,
"height": 75,
"width": 100,
"resource": "https://media.activitiesbank.com/16457/ENG/S/DSCI0125%20%284%29.JPG",
"sizeType": "SMALL"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/XL/DSCI0125%20%284%29.JPG",
"sizeType": "XLARGE"
},
{
"dpi": 72,
"height": 480,
"width": 640,
"resource": "https://media.activitiesbank.com/16457/ENG/B/DSCI0125%20%284%29.JPG",
"sizeType": "LARGE2"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/LPP/DSCI0125%20%284%29.JPG",
"sizeType": "RAW"
},
{
"dpi": 72,
"height": 200,
"width": 267,
"resource": "https://media.activitiesbank.com/16457/ENG/L/DSCI0125%20%284%29.JPG",
"sizeType": "LARGE"
},
{
"dpi": 72,
"height": 130,
"width": 173,
"resource": "https://media.activitiesbank.com/16457/ENG/M/DSCI0125%20%284%29.JPG",
"sizeType": "MEDIUM"
}
]
},
{
"visualizationOrder": 6,
"mimeType": "image/jpeg",
"urls": [
{
"dpi": 72,
"height": 75,
"width": 100,
"resource": "https://media.activitiesbank.com/16457/ENG/S/DSC_0854.JPG",
"sizeType": "SMALL"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/XL/DSC_0854.JPG",
"sizeType": "XLARGE"
},
{
"dpi": 72,
"height": 480,
"width": 640,
"resource": "https://media.activitiesbank.com/16457/ENG/B/DSC_0854.JPG",
"sizeType": "LARGE2"
},
{
"dpi": 72,
"height": 768,
"width": 1024,
"resource": "https://media.activitiesbank.com/16457/ENG/LPP/DSC_0854.JPG",
"sizeType": "RAW"
},
{
"dpi": 72,
"height": 200,
"width": 267,
"resource": "https://media.activitiesbank.com/16457/ENG/L/DSC_0854.JPG",
"sizeType": "LARGE"
},
{
"dpi": 72,
"height": 130,
"width": 173,
"resource": "https://media.activitiesbank.com/16457/ENG/M/DSC_0854.JPG",
"sizeType": "MEDIUM"
}
]
}
]
},
"notes": [
{
"dateFrom": "2020-01-01",
"dateTo": "2021-01-31",
"descriptions": [
{
"description": "As a result of local government measures and guidelines put in place by services providers – including hotels and ancillaries – guests may find that some facilities or services are not available. Please visit https://corporate.hotelbeds.com/hotelbeds-update-covid-19 for further information."
}
]
}
],
"segmentationGroups": [
{
"code": 1,
"name": "Categories",
"segments": [
{
"code": 1,
"name": "Sightseeing, tours and museums"
}
]
},
{
"code": 3,
"name": "Activity duration",
"segments": [
{
"code": 200,
"name": "Half-day morning"
},
{
"code": 205,
"name": "Half-day afternoon"
}
]
},
{
"code": 16,
"name": "Services",
"segments": [
{
"code": 946,
"name": "Private"
},
{
"code": 956,
"name": "Safe2Stay"
}
]
}
],
"activityFactsheetType": "TOURS",
"activityCode": "E-E10-IN-JACITY",
"modalityCode": "PRIVATE@STANDARD|ENG|13:30",
"contentId": "16457",
"description": "Within the city of Jaipur are a number of interesting sights. The first is the city palace and museum, dating from the early 18th century and belonging to the ruling Jaipur family. The palace houses a textile museum, armoury and art gallery, with some stunning pictures showing the pageantry and pomp of life as an aristocrat. The palace can get busy with tour groups, but if you wait for only a few minutes, the group will have rushed on to something new.Just outside the city palace is the Jantar Mantar, or observatory, built under the instructions of the astronomer King Sawai Jai Singh, in 1728, which has been designated as a world heritage site by UNESCO.
\n
\nThe observatory requires a competent explanation, but with a good guide, you will really appreciate the complexity and detail which was needed to construct this amazing piece of work. The sun dials are accurate to within 2 seconds and are corrected for the local time in Jaipur, which is some minutes different from Delhi. In addition, there are a dozen structures which fix the position of the sun in each of the astrological signs. Astrology has always played an important part in Hindu life and is still used today before any business, political or marriage arrangement is undertaken.
\n
\nThe Hawa Mahal, or Palace of the Winds, lies adjacent to the main road between the city centre and Amber, the former capital. The five-storied structure was built in 1799 for the women of the royal entourage to observe the pageants passing along the streets below. The building is only one room deep, and is therefore only a facade, rather than a palace. You cannot actually enter the building but you can stop on the roadside to view the Palace and take photographs if you wish.
\\nRedeem information
Voucher type: Printed and e-Voucher
Printed voucher or E-voucher. Print and bring the voucher or show the voucher on your mobile device to enjoy the activity.
Location
Start point:
Hotel pickup
End point: Same as the starting point
Schedule
Duration: 4 Hours
Guide options
Guide type: Guide
Requirements
Please make sure you answer all the mandatory questions during the booking process and ensure that you have provided your correct email address.
\\n",
"countries": [
{
"code": "IN",
"name": "India",
"destinations": [
{
"code": "JAI",
"name": "Jaipur"
}
]
}
]
}
}
]
}
}
}