Endpoints for searching and retrieving product details.
BeMyGuest API v2.0 (2.1)
The BeMyGuest API is the industry benchmark preferred by online travel agents, designed solely for Asia's attractions, tours and activities. This comprehensive API provides real-time access to a vast inventory of travel products.
- Product Discovery: Search and retrieve detailed information for a wide range of travel products, including attractions, tours, and activities.
- Real-Time Availability and Pricing: Check live availability and get up-to-date pricing for specific product types and dates.
- End-to-End Booking Management: Create, confirm, and cancel bookings seamlessly.
- Voucher Retrieval: Access and download booking vouchers directly through the API.
- Configuration: Fetch essential configuration data such as supported languages, currencies, and locations to customize your integration.
Download OpenAPI description
Overview
URL
BeMyGuest API Support
Languages
Servers
Mock server
https://docs.bemyguest.com.sg/_mock/openapi/
Api Demo Server
https://api.demo.bemyguest.com.sg/
Api Production Server
https://api.bemyguest.com.sg/
Bodyapplication/jsonrequired
Full version of a Product's Details
true/false, Depreciated. When airportPickup is true, customer need to provide airport information. This value has been depreciated. It may be appear as booking option instead.
Available languages for Audio Headset material
true/false, Depreciated. When hotelPickup is true, customer need to provide hotel name and address. This value has been depreciated. It may be appear as booking option instead
Activity itinerary - only applicable for Package type, will be null for others
Default "null"
translated version of itinerary on requested language
Default "null"
Array of photos in different dimensions (Sizes: original, 75x50, 175x112, 680x325). Please download the images to your platform. DO NOT hotlinking to these images
translated version of safety information on requested language
Default "null"
Available translated languages for product.
Start date for product availability (or null when no limit)
Default "null"
End date if product availability (or null when no limit)
Default "null"
Warnings of the activity (related to safety and insurance)
Default "null"
translated version of warnings on requested language
Default "null"
Available written languages for reading material.
Information on Covid-19 notice of Safety Standards of visiting the attractions
Default "null"
Information on Covid-19 notice of Safety Standards of visiting the attractions on requested language
Default "null"
true/false (An indication to tell if the Product has the same price for each pax in all of its productTypes)
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/product_available
- Api Demo Server
https://api.demo.bemyguest.com.sg/product_available
- Api Production Server
https://api.bemyguest.com.sg/product_available
application/json
{ "type": "product_available", "data": { "additionalInfo": "string", "additionalInfoTranslated": "string", "address": "Gateway Ave, Singapore", "allProductTypesHaveOptions": false, "airportPickup": false, "averageDelivery": 64, "audioHeadsetLanguages": [], "basePrice": 69.13, "businessHoursFrom": "10:00", "businessHoursTo": "20:00", "categories": [ … ], "covid19Measures": "no information", "covid19MeasuresTranslated": "no information", "currency": { … }, "description": "Experience different cutting-edge rides, shows, and attractions based on your favourite blockbuster films and television series at Universal Studios Singapore. This skip-the-line e-ticket will let guests have access to the seven zones of the park, including Hollywood, New York, Sci-Fi City, Ancient Egypt, Lost World, Far Far Away, and Madagascar.\\r\\n\\r\\nIn Hollywood, ticket holders can try rollercoasters and other movie-themed attractions.", "descriptionTranslated": "在新加坡环球影城体验基于您最喜爱的大片和电视剧的不同尖端游乐设施、表演和景点。这张免排队电子门票将让游客可以进入公园的七个区域，包括好莱坞、纽约、科幻城、古埃及、失落的世界、遥远之地和马达加斯加。\\r\\n \\r\\n在好莱坞，持票者可以尝试过山车和其他电影主题的景点。", "hasOptions": false, "highlights": "Experience cutting-edge rides, shows, and attractions at Universal Studios Singapore\\nVisit the seven themed zones of the park like Ancient Egypt, Lost World, and Madagascar\\nMeet your favourite movie and TV characters like Shrek, Puss in Boots, and the Madagascar gang", "highlightsTranslated": "在新加坡环球影城体验尖端的游乐设施、表演和景点\\n参观公园的七个主题区，如古埃及、失落的世界和马达加斯加\\n认识你最喜欢的电影和电视角色，如怪物史莱克、穿靴子的猫和马达加斯加帮派", "hotelPickup": false, "isFlatPaxPrice": true, "isSrvEligible": false, "itinerary": "no itinerary", "itineraryTranslated": "no itinerary", "latitude": "1.2544975", "locations": [ … ], "longitude": "103.8251792", "maxPax": 10, "minPax": 1, "photos": { … }, "photosUrl": "https://s3.amazonaws.com/playground.bemyguest.com.sg", "priceIncludes": "Admission fee", "priceIncludesTranslated": "入场费", "reviewAverageScore": 4, "reviewCount": 1, "safety": "no information", "safetyTranslated": "no information", "title": "Universal Studios Singapore E-ticket (Test)", "titleTranslated": "新加坡环球影城电子门票（测试）", "tourType": "join", "typeName": "Attraction", "translationLanguages": [ … ], "updatedAt": "2020-03-13 17:31:00", "uuid": "d5a03ea2-e06e-5d01-84b7-94530b1059f7", "validFrom": "2020-01-01", "validThrough": "2024-01-20", "warnings": "- The park shall remain operational in case of light rains. The decision to proceed is up to the ticket holder.\\r\\n\\r\\nSafety and insurance:\\r\\n- Children below 12 years old must be accompanied by a paying adult at all times.\\r\\n- Detailed information about ride restrictions can be found at the Guest Services Windows located at the front part of the park. It is also available at the Guest Services Lobby inside the park.", "warningsTranslated": "- 若遇小雨，公园将照常开放。是否继续进行的决定取决于持票人。\\r\\n\\r\\n安全和保险：\\r\\n- 12 岁以下儿童必须始终由付费成人陪同。\\r\\n- 详细信息有关乘车限制的信息，请前往位于公园前部的游客服务窗口。您也可以在公园内的宾客服务大厅购买。", "writtenLanguages": [] }, "signature": "string", "timestamp": "2019-08-24T14:15:22Z" }
Bodyapplication/jsonrequired
Full version of a Product's Details
true/false, Depreciated. When airportPickup is true, customer need to provide airport information. This value has been depreciated. It may be appear as booking option instead.
Available languages for Audio Headset material
true/false, Depreciated. When hotelPickup is true, customer need to provide hotel name and address. This value has been depreciated. It may be appear as booking option instead
Activity itinerary - only applicable for Package type, will be null for others
Default "null"
translated version of itinerary on requested language
Default "null"
Array of photos in different dimensions (Sizes: original, 75x50, 175x112, 680x325). Please download the images to your platform. DO NOT hotlinking to these images
translated version of safety information on requested language
Default "null"
Available translated languages for product.
Start date for product availability (or null when no limit)
Default "null"
End date if product availability (or null when no limit)
Default "null"
Warnings of the activity (related to safety and insurance)
Default "null"
translated version of warnings on requested language
Default "null"
Available written languages for reading material.
Information on Covid-19 notice of Safety Standards of visiting the attractions
Default "null"
Information on Covid-19 notice of Safety Standards of visiting the attractions on requested language
Default "null"
true/false (An indication to tell if the Product has the same price for each pax in all of its productTypes)
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/product_updated
- Api Demo Server
https://api.demo.bemyguest.com.sg/product_updated
- Api Production Server
https://api.bemyguest.com.sg/product_updated
application/json
{ "type": "product_updated", "data": { "additionalInfo": "string", "additionalInfoTranslated": "string", "address": "Gateway Ave, Singapore", "allProductTypesHaveOptions": false, "airportPickup": false, "averageDelivery": 64, "audioHeadsetLanguages": [], "basePrice": 69.13, "businessHoursFrom": "10:00", "businessHoursTo": "20:00", "categories": [ … ], "covid19Measures": "no information", "covid19MeasuresTranslated": "no information", "currency": { … }, "description": "Experience different cutting-edge rides, shows, and attractions based on your favourite blockbuster films and television series at Universal Studios Singapore. This skip-the-line e-ticket will let guests have access to the seven zones of the park, including Hollywood, New York, Sci-Fi City, Ancient Egypt, Lost World, Far Far Away, and Madagascar.\\r\\n\\r\\nIn Hollywood, ticket holders can try rollercoasters and other movie-themed attractions.", "descriptionTranslated": "在新加坡环球影城体验基于您最喜爱的大片和电视剧的不同尖端游乐设施、表演和景点。这张免排队电子门票将让游客可以进入公园的七个区域，包括好莱坞、纽约、科幻城、古埃及、失落的世界、遥远之地和马达加斯加。\\r\\n \\r\\n在好莱坞，持票者可以尝试过山车和其他电影主题的景点。", "hasOptions": false, "highlights": "Experience cutting-edge rides, shows, and attractions at Universal Studios Singapore\\nVisit the seven themed zones of the park like Ancient Egypt, Lost World, and Madagascar\\nMeet your favourite movie and TV characters like Shrek, Puss in Boots, and the Madagascar gang", "highlightsTranslated": "在新加坡环球影城体验尖端的游乐设施、表演和景点\\n参观公园的七个主题区，如古埃及、失落的世界和马达加斯加\\n认识你最喜欢的电影和电视角色，如怪物史莱克、穿靴子的猫和马达加斯加帮派", "hotelPickup": false, "isFlatPaxPrice": true, "isSrvEligible": false, "itinerary": "no itinerary", "itineraryTranslated": "no itinerary", "latitude": "1.2544975", "locations": [ … ], "longitude": "103.8251792", "maxPax": 10, "minPax": 1, "photos": { … }, "photosUrl": "https://s3.amazonaws.com/playground.bemyguest.com.sg", "priceIncludes": "Admission fee", "priceIncludesTranslated": "入场费", "reviewAverageScore": 4, "reviewCount": 1, "safety": "no information", "safetyTranslated": "no information", "title": "Universal Studios Singapore E-ticket (Test)", "titleTranslated": "新加坡环球影城电子门票（测试）", "tourType": "join", "typeName": "Attraction", "translationLanguages": [ … ], "updatedAt": "2020-03-13 17:31:00", "uuid": "d5a03ea2-e06e-5d01-84b7-94530b1059f7", "validFrom": "2020-01-01", "validThrough": "2024-01-20", "warnings": "- The park shall remain operational in case of light rains. The decision to proceed is up to the ticket holder.\\r\\n\\r\\nSafety and insurance:\\r\\n- Children below 12 years old must be accompanied by a paying adult at all times.\\r\\n- Detailed information about ride restrictions can be found at the Guest Services Windows located at the front part of the park. It is also available at the Guest Services Lobby inside the park.", "warningsTranslated": "- 若遇小雨，公园将照常开放。是否继续进行的决定取决于持票人。\\r\\n\\r\\n安全和保险：\\r\\n- 12 岁以下儿童必须始终由付费成人陪同。\\r\\n- 详细信息有关乘车限制的信息，请前往位于公园前部的游客服务窗口。您也可以在公园内的宾客服务大厅购买。", "writtenLanguages": [] }, "updatedFields": [ "string" ], "signature": "string", "timestamp": "2019-08-24T14:15:22Z" }
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/product_type_available
- Api Demo Server
https://api.demo.bemyguest.com.sg/product_type_available
- Api Production Server
https://api.bemyguest.com.sg/product_type_available
application/json
{ "productUuid": "3a88375a-5ea7-4e22-b7fe-b3c10f9367f3", "productTypeUuid": "93d69d2b-cfee-42c6-9a3c-b1977ed661f0", "endpoint": "string", "type": "product_type_available", "timestamp": "2019-08-24T14:15:22Z", "signature": "string" }
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/product_type_not_available
- Api Demo Server
https://api.demo.bemyguest.com.sg/product_type_not_available
- Api Production Server
https://api.bemyguest.com.sg/product_type_not_available
application/json
{ "productUuid": "3a88375a-5ea7-4e22-b7fe-b3c10f9367f3", "productTypeUuid": "93d69d2b-cfee-42c6-9a3c-b1977ed661f0", "type": "product_type_not_available", "timestamp": "2019-08-24T14:15:22Z", "signature": "string" }
Bodyapplication/jsonrequired
The full ProductType Details information object
How many days in advance booking can be made. NULL if not applicable
Is an infant allowed for this product type (there is no pricing for infants!)
Maximum number of group: sum of adults, children and senior or null when not applicable
Minimum number of group: sum of adults, children and senior or null when not applicable
TRUE then confirmed booking this product should return new Booking status = approved, but if we're out of stock of e-tickets it can still return a 'Waiting' status
TRUE, the voucher allows direct admission, otherwise customer needs to redeem vouchers. Information about voucher redemption is showed in voucherUse and voucherRedemptionAddress
Voucher redemption address if client needs to redeem a voucher.
Default "null"
voucherRedemptionAddress translated on requested language.
Default "null"
TRUE voucher needs to be printed. Otherwise, it can be presented eg. on mobile device
Translated version of meetingLocation on requested language
Default "null"
Cancellation Policies only applicable for refundable product
Summary of Cancellation Policies for refundable product
List of all ticket types for this product type
Available timeslots for product, might be null. If the ProductType has timeslots, the timeslotUUID of the product is REQUIRED in Check a Booking and Create a new booking methods
Booking options
Options per booking array
Options that are required/available for each person on the booking
true/false, indicate whether product type has booking option that require file upload
true/false, indicate whether product type has booking option which has a price.
true/false, indicate whether product type has booking option which has a price and required is TRUE
First date that is available for booking. 'False' if there is no availability date Use calendar endpoint to check availability
Is an adult allowed to book this product type true/false. Use the ticketTypes object for this information
Minimum number of adults. NULL if not applicable. Use the ticketTypes object for this information
Maximum number of adults. NULL if not applicable. Use the ticketTypes object for this information
Minimum age allowed for an adult. NULL if not applicable. Use the ticketTypes object for this information
Maximum age allowed for an adult. NULL if not applicable. Use the ticketTypes object for this information
Minimum number of children or null when not allowed. NULL if not applicable. Use the ticketTypes object for this information
Maximum number of children or null when not allowed. NULL if not applicable. Use the ticketTypes object for this information
Minimum age allowed for a child. NULL if not applicable. Use the ticketTypes object for this information
Maximum age allowed for a child. NULL if not applicable. Use the ticketTypes object for this information
Is a senior allowed to book this product type. Use the ticketTypes object for this information
Minimum number of seniors. NULL if not applicable. Use the ticketTypes object for this information
Maximum number of senior. NULL if not applicable. Use the ticketTypes object for this information
Minimum age allowed for a senior. NULL if not applicable. Use the ticketTypes object for this information
Maximum age allowed for a senior. NULL if not applicable. Use the ticketTypes object for this information
Recommended markup to adult prices if you want to match with BMG's recommended prices (RRP). Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
Recommended markup for child prices if you want to match with BMG's recommended prices (RRP). Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
Recommended markup for senior prices if you want to match with BMG's recommended prices (RRP). Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
Minimal retail price for adult. Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
Minimal retail price for child. Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
Minimal retail price for senior. Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
The rate that an adult get directly at the attraction website or gate. Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
The rate that a child get directly at the attraction website or gate. Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
The rate that a senior get directly at the attraction website or gate. Null if not applicable. Use either the calendar endpoint or price-list endpoint to check pricing
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/product_type_content_updated
- Api Demo Server
https://api.demo.bemyguest.com.sg/product_type_content_updated
- Api Production Server
https://api.bemyguest.com.sg/product_type_content_updated
application/json
{ "type": "product_type_content_updated", "data": { "uuid": "d11b9919-4da2-5a4c-bcea-c3b9f688cc62", "title": "River Safari Admission with Two Boat Rides", "titleTranslated": "River Safari Admission with Two Boat Rides", "description": "description.... descriptions....", "descriptionTranslated": "descriptions...descriptions....", "durationDays": 0, "durationHours": 8, "durationMinutes": 0, "daysInAdvance": 1, "cutOffTime": "17:00", "firstAvailabilityDate": "2024-01-20", "isNonRefundable": true, "allowAdults": true, "minPax": 1, "maxPax": 10, "minAdultAge": 13, "maxAdultAge": 60, "hasChildPrice": true, "allowChildren": true, "minChildren": 0, "maxChildren": 10, "minChildAge": 6, "maxChildAge": 12, "allowSeniors": true, "minSeniors": 0, "maxSeniors": 10, "minSeniorAge": 61, "maxSeniorAge": 90, "allowInfant": true, "minInfantAge": 0, "maxInfantAge": 2, "maxGroup": 5, "minGroup": 2, "instantConfirmation": true, "nonInstantVoucher": false, "directAdmission": true, "voucherUse": "instruction..instruction....", "voucherUseTranslated": "how to use....how to use....", "voucherRedemptionAddress": "redeem here....redeem here....", "voucherRedemptionAddressTranslated": "redeem here...redeem here....", "voucherRequiresPrinting": false, "meetingTime": "13:00", "meetingAddress": "This address...this address", "meetingLocation": "Meet here....meet here...", "meetingLocationTranslated": "Meet here....meet here....", "cancellationPolicies": [ … ], "cancellationPolicySummary": "Cancellation of at least 48 hrs before arrival: 100% refund\\nCancellation between 48 hrs and 24 hrs before arrival: 10% refund\\nExtra cancellation or refund fees may apply. Any cancellations falling outside of the above policy are strictly non-refundable", "recommendedMarkup": 66.67, "childRecommendedMarkup": 66.67, "seniorRecommendedMarkup": 66.67, "adultParityPrice": 60, "childParityPrice": 60, "seniorParityPrice": 60, "adultGateRatePrice": 80, "childGateRatePrice": 80, "seniorGateRatePrice": 80, "ticketTypes": [ … ], "validity": { … }, "timeslots": [ … ], "timezone": "Europe/Berlin", "options": { … }, "hasOptions": true, "hasFileUploadOptions": false, "hasPriceOptions": false, "hasRequiredPriceOptions": false, "isBmgVoucher": false, "isSrvEligible": false }, "updatedFields": [ "string" ], "signature": "string", "timestamp": "2019-08-24T14:15:22Z" }
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/booking_status_updated
- Api Demo Server
https://api.demo.bemyguest.com.sg/booking_status_updated
- Api Production Server
https://api.bemyguest.com.sg/booking_status_updated
application/json
{ "bookingUuid": "91151bb5-cb15-45c8-9a6c-0c1cd4bce36f", "previousStatus": "string", "currentStatus": "string", "type": "booking_status_updated", "timestamp": "2019-08-24T14:15:22Z", "signature": "string" }
Bodyapplication/jsonrequired
This object is returned in the response whenever a booking is created, modified or viewed in the API
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/booking_data_updated
- Api Demo Server
https://api.demo.bemyguest.com.sg/booking_data_updated
- Api Production Server
https://api.bemyguest.com.sg/booking_data_updated
application/json
{ "type": "booking_data_updated", "bookingUuid": "91151bb5-cb15-45c8-9a6c-0c1cd4bce36f", "data": { "adults": 0, "amountBreakdown": [ … ], "arrivalDate": "2019-08-24", "cancellationRequestAt": "string", "cancellationRequestStatus": "string", "cancellationStatus": "string", "children": 0, "code": "string", "completedAt": "string", "createdAt": "string", "currencyCode": "string", "currencyUuid": "cd8aed70-26ae-4fd6-bda6-2518f23cc3e4", "email": "user@example.com", "firstName": "string", "lastName": "string", "links": [ … ], "options": [], "partnerReference": "string", "phone": "string", "productTypeTitle": "string", "productTypeTitleTranslated": "string", "productTypeUuid": "93d69d2b-cfee-42c6-9a3c-b1977ed661f0", "refundAmount": 0, "refundDate": "string", "refundTransaction": "string", "salutation": "string", "seniors": 0, "status": "string", "ticketTypes": [ … ], "timeSlot": "string", "totalAmount": 0, "updatedAt": "string", "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f" }, "updatedFields": [ "string" ], "signature": "string", "timestamp": "2019-08-24T14:15:22Z" }
Bodyapplication/jsonrequired
voucher download links - partner is required to download the vouchers to their system
- Mock server
https://docs.bemyguest.com.sg/_mock/openapi/booking_tickets_updated
- Api Demo Server
https://api.demo.bemyguest.com.sg/booking_tickets_updated
- Api Production Server
https://api.bemyguest.com.sg/booking_tickets_updated
application/json
{ "bookingUuid": "91151bb5-cb15-45c8-9a6c-0c1cd4bce36f", "data": [ { … } ], "type": "booking_tickets_updated", "timestamp": "2019-08-24T14:15:22Z", "signature": "string" }